Skip to content

Commit 6ae7ba8

Browse files
Update readMe
1 parent 27a0a9f commit 6ae7ba8

File tree

4 files changed

+676
-78
lines changed

4 files changed

+676
-78
lines changed

README.md

+39-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,39 @@
1-
# mr-react-native-starter
1+
# mr-react-native-starter
2+
3+
### **Start your project the easiest way**
4+
5+
##### Highly flexible , High scalability ,Compatible with vsode, Redux , Axios , Redux-thunk , Redux-persist and Styled-components , ESlint, Prettier
6+
7+
This project is based on the [Expo](https://reactnative.dev/docs/getting-started 'Expo'). Therefore, you can refer to its documentation to install **react-native** and **Expo**.
8+
9+
In this structure, we tried to bring you a good experience by combining different technologies.
10+
11+
## The main structure is as follows:
12+
13+
- **components**
14+
- **Common** _general components_
15+
- **Screens** _partials and styles for every main screen_
16+
- **screens** _main screen pages_
17+
- **helpers** _utils and javascript helpers_
18+
- **constants**
19+
- **theme** _config global colors and styles_
20+
- **endpoints** _object of endpoints servieces_
21+
- **store** _redux repository for every main screen_
22+
23+
## installation:
24+
25+
Assuming that you have [Node 12 LTS](https://nodejs.org/en/download/ 'Node 12 LTS') or greater installed, you can use npm to install the Expo CLI command line utility:
26+
27+
_Install eslint, prettier and editor config plugins into your IDE_
28+
29+
1. `npm install -g expo-cli`
30+
31+
2. `npm install –g react-native-cli`
32+
33+
3. `git clone https://github.com/MostafaRastegar/mr-react-native-starter.git`
34+
35+
4. `cd mr-react-native-starter`
36+
37+
5. `npm install`
38+
39+
6. `npm run web` or `npm run android` or `npm run ios`

0 commit comments

Comments
 (0)