The Relay Books App is a project to show some of the cool features you can create using Relay and GraphQL.
Choose a folder to save the project and clone the repository:
git clone https://github.com/jean-leonco/relay-books-app.gitEnsure you have the following resources to run properly the app:
Access the project folder and ensure that you are in the root. Then in your terminal, run:
yarn startupThis script will lead you to a serie of process. First, all dependencies are installed. Then, all necessary .env files are created to save your time. Finally, the GraphQL Schema is updated and the relay queries/mutations are generated.
You can run some commands for the app or the server inside the root directory:
- To install the app on an Android device, run
yarn android - To install the app on an iOS device, run
yarn ios - To start the app metro bundler, run
yarn app - To compile relay queries and mutations, run
yarn relay
- To update the GraphQL schema, run
yarn update-schema - To start the development server, run
yarn graphql - To seed the database, run
yarn database:seed - To test the server, run
yarn server:test
| command | function |
|---|---|
| android | install app on android |
| app | start metro bundler server |
| app:pod | install pod for ios |
| db:seed | seed database |
| delete:all | run all delete commands |
| delete:build | delete build dir |
| delete:generated | delete all relay generated files |
| delete:metro-cache | delete metro bundler cache |
| delete:node_modules | delete node_modules |
| delete:yarn.lock | delete yarn.lock |
| ios | install app on ios |
| lint | run eslint check |
| lint:fix | run eslint check and fix lint errors |
| prettier | run prettier |
| relay | compile relay queries and mutations |
| server | run development graphql server |
| server:build | build server |
| server:test | test server |
| startup | install deps and, copy .env and update schema/relay |
| test | test all packages that have tests |
| update | update schema/relay |
| update-schema | update GraphQL schema |