The recommended IDE for this project is VS Code with the following extensions
Native iOS dependencies are installed with CocoaPods, which should be installed with Bundler.
Installing the project and its dependencies
yarn && yarn install-ios
This should install React, React-Native, Typescript and any other Javascript dependencies, along with installing (if necessary) CococaPods and iOS dependencies.
Building the app can be done in the following ways:
There are embedded build tasks for both, iOS and Android.
By running in the Terminal:
ENVFILE=[path_to_env] react-native run-{ios|android}
Open MindBlown.xcworkspace from the ios/ directory and select the MindBlown scheme before triggering the build.
You should run tests by calling yarn test, but if you want to debug unit tests or run the tests for a single file, there are embedded build tasks for launching Jest with VS Code. These will run in a separate terminal and attach to VS Code's debugger.
The following scripts are embedded with the package:
| Name | Description |
|---|---|
install-ios |
Installs iOS dependencies |
lint |
Runs TSLint |
test |
Runs tests in the application |
update-icons |
Reads SVG files in assets/icons and stores in assets/icons.ts |
gen-licenses |
Compiles the dependencies' licenses into a single file |
update-version |
Updates app with the given version |
The following bash scripts are available in the scripts/ directory:
| Name | Description |
|---|---|
reset-metro |
Starts the react-native package with a clean cache |
reset-metro--hard |
Clears watchman, deletes the node_modules dir and starts the packager with a clean cache |
See the LICENSE file for more info.