docs: update development workflow. closes #133

This commit is contained in:
satyajit.happy
2019-07-08 12:21:04 +02:00
parent a1b459fdef
commit 5039391dc5

View File

@@ -27,10 +27,30 @@ export default createStackNavigator({
## Development workflow
- Clone this repository
- Run `yarn` in the root directory and in the `example` directory
- Run `yarn dev` in the root directory
- Run `yarn start` in the `example` directory
To setup the development environment, open a Terminal in the repo directory and run the following:
```sh
yarn bootstrap
```
While developing, you can run the example app with [Expo](https://expo.io/) to test your changes:
```sh
yarn example start
```
Make sure your code passes TypeScript and ESLint. Run the following to verify:
```sh
yarn typescript
yarn lint
```
To fix formatting errors, run the following:
```sh
yarn lint --fix
```
## Docs