Robot Race

Based on a board game.

Forked from this commit of pig-card-game.

Development

1. npm install
2. npm start - This starts 4 docker containers
   • robot-race-server: handles http requests
   • robot-race-worker: handles game logic
   • robot-race-front-end: rebuilds front-end during development
   • redis: a Redis instance

Forking (on different GitHub account)

1. Click the fork button

Forking (on same or different GitHub account)

1. Create new empty repository on GitHub (or whatever)
2. git clone https://github.com/nick-ng/robot-race.git <new-repo> && cd <new-repo>
3. Change robot-race to whatever you want and change my name to your name or something.
4. git add . && git commit -m "anything. this will get squashed in the next step"
5. git reset $(git commit-tree HEAD^{tree} -m "forked https://github.com/nick-ng/robot-race")
6. git remote remove origin
7. git remote add origin <url-of-repo-you-made>
8. git push --set-upstream origin main
9. Change branch permissions etc.

Deploying

1. ./build.sh or docker compose -f docker-compose.prod.yml build
2. ./serve.sh or PORT=<desired-port> docker compose -f docker-compose.prod.yml up -d

Deploying to Heroku

1. Change .github\workflows\deploy-front-end.yml so the API_ORIGIN is your Heroku App's url e.g. API_ORIGIN=https://${{secrets.HEROKU_APP_NAME}}.herokuapp.com
2. Create an empty Heroku App. Note the app's name
3. Get your Heroku API key from https://dashboard.heroku.com/account
4. On GitHub repo for your fork, go to the Settings and click on Secrets > Actions
5. Add 3 new repository secrets
   • HEROKU_API_KEY: API key from above
   • HEROKU_APP_NAME: App name from above
   • HEROKU_EMAIL: Email address of your Heroku account
6. Push a commit to the main branch
7. Manually run the "Deploy Back-end" GitHub action

If you deploy to Heroku often, you can un-comment the "push" trigger in .github\workflows\deploy-back-end.yml

Unit Tests

Create a /spec directory next to the files you want to test then create a file <name-of-file-to-test>.spec.cjs in that.

ToDos

Check this GitHub Project for details.