You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[`App/Images`](App/Images): images used by the application
29
30
-[`App/Stores`](App/Stores): redux [actions, reducers and stores](https://redux.js.org/basics)
@@ -41,22 +42,26 @@ You also need to install the dependencies required by React Native:
41
42
- for [Android development](https://facebook.github.io/react-native/docs/getting-started.html#installing-dependencies-3)
42
43
- for [iOS development](https://facebook.github.io/react-native/docs/getting-started.html#installing-dependencies)
43
44
44
-
## Usage
45
+
## Using the boilerplate
45
46
46
47
To create a new project using the boilerplate:
47
48
48
49
- clone this repository
49
50
- remove the previous git history: `rm -rf .git/`
51
+
- install the npm dependencies by running `yarn`
50
52
- rename the React Native project to your own project name: `npm run rename -- <YourProjectName>` (the default name is `Boilerplate`)
51
-
- remove the LICENSE file and the License section from the README if your project is not open source
53
+
- remove the LICENSE file and the "License" section from the README if your project is not open source
52
54
53
-
Feel free to remove this section from the README as you will no longer need it in your project. You are encouraged to keep the rest of the documentation in your project so that it is self-explanatory.
55
+
Feel free to remove the section "Using the boilerplate" from the README (you will not need it anymore in your project). You are encouraged to keep the rest of the documentation in your project so that it is self-explanatory.
56
+
57
+
You can now create a new git repository for your project (using `git init`) and create the first commit.
54
58
55
59
## Running the project
56
60
57
61
Assuming you have all the requirements installed, you can setup and run the project by running:
58
62
59
63
-`yarn install` to install the dependencies
64
+
- create your [configuration file `App/Config/index.js`](App/Config) from `index.dev.js` (in you are in dev environment) and fill the missing values
60
65
-`react-native run-android` to run the Android application (remember to start a simulator or connect an Android phone)
61
66
-`react-native run-ios` to run the iOS application (remember to start a simulator or connect an iPhone phone)
0 commit comments