Site URL: https://example.com
This template uses:
- Node 12 LTS
- Typescript 4
- Parcel frontend with React
- Express backend
- Replace all occurrences of
team-osh-reddit
with your actual app name - Uncomment the "deployment" block in .github/workflows/ci.yml if you would like to deploy to heroku after each push to master
- Delete the "About this template" section of the README :)
- Open a terminal
- Install dependencies using the command
npm install
- Run the site using
npm run dev
- Go to http://localhost:8080
The full test suite needs to be run before doing any push to master. That's to prevent ourselves from breaking the live version of the website. Follow these steps before each push to master:
- Open a terminal
- Run
./build.sh
- If you get a "SUCCESS" message, you can push. If you get a failed message or any other error, do not push. Fix the problem and then run the tests again before pushing.
During development, you might just want to run a subset of the tests locally.
- Unit and integration tests:
npm run test
ornpm run test:watch
- Acceptance tests:
npm run test:acceptance
The app is deployed automatically as part of a CI pipeline. When code is pushed to master and all CI tests succeed, the code will be deployed to live.