Insert links to production (API, site, expo QR code, ...)
[Frontend](Add link to the frontend GitHub repo)
[Backend](Add link to the backend GitHub repo)
[CMS](Add link to the CMS GitHub repo)
List the people who worked on this project
| Item | Info / links | Remark |
|---|---|---|
| Framework | insert basic stack info, eg: "Nest.js + Graphql" | |
| Partnership hub | insert link to the Notion page of this track | |
| Hosting provider | insert link to GCP / Vercel /... | |
| Architecture map | link to architecture map in Miro | |
| Translations | link to translations | |
| Doppler | link to Doppler | |
| Authentication | link to auth provider, eg: Auth0, Firebase, ... | |
| Figma | link to Figma file | |
| Other | List all tools, should already be in Notion or Lastpass, so a link to this page will be enough |
Describe how to manage the project secrets
Describe how to get the project up and running on your local machine
Describe how to publish the project to the different environments
Describe how to run the tests and what parts of the code are / should be tested
- Tests run automatically on
git pushusing GitHub Actions - Tests run automatically on pull requests using GitHub Actions
- You can run manual tests using
yarn test
If needed, give some extra info about the certain flows that need some explanation
Examples:
- https://github.com/bothrs/my-cancer-companion-backend#special-flows
- https://github.com/bothrs/la-belle-maison-backend#how-the-login-works
List the cron jobs that are used
Examples: