Health and Fitness application built by gamers for gamers. Read blogs, build diet and exercise plans, and connect with other likeminded people. Application currently deployed to our DEV environment
This section documents recommended tooling for this project. Feel free to use whatever tooling best suits your development needs. It makes no assumption about skills or experience, so highlights everything that needs to be done to get started.
For convenience, a single script has been provided for initializing your local development environment. This is currently idempotent, so as new features are added to the toolchain, re-running this script should have no negative consequences. If that changes, this documentation will be updated to reflect that.
To initialize your local dev environment simply open a terminal and execute
npm run tooling:initTo start local dev, execute the following npm command:
npm run devThis will start a development app on localhost:3000, wait for that app to boostrap, and then also start the Prisma db explorer. A new tab should be opened in your window for both of these applications. Note that you can also execute each action individually via
npm run dev:startand
npm run db:explorerWorking on features or bugs typically follows a fairly simple flow:
- Checkout trunk (main)
- Pull most recent changes from remote
- Checkout feature
- Do work
- Push to remote branch and open pull request
- Iterate on feedback/fixes
- Upon approval, squash and merge
Branch naming generally falls into one of two buckets:
- {bug | feature | chore}/{short description}
For example, feature/setup-react-router
The Issues # should also be referenced in the commit. For example:
Fixes #9999, adds super awesome feature