wabtytsai / spirit-island-helper

2 stars 0 forks source link

Spirit Island Helper

A pet project that I'm working for the board game Spirit Island. It is intended to streamline the game by automating setup, building invader decks, fear counting, and blight reminders. It is not intended to replace the core game.

Spirit Island Helper

setup

Make sure you have node and npm. If not, install it. E.g:

brew install node

For the first time, you should build the project

npm install
npm run build

Then run it with

npm start

You can go to http://localhost:3000/ and see it in action. Any changes that are saved will auto-refresh the page.

Development

Always work on a new branch to avoid accidents

git checkout -b <branch_name>

Make some changes, and when you are ready, commit and submit a PR

git add .
git commit -m "meaningful commit message"

Push it

git push

or if this is a new branch with no upstream, set the upstream with:

git push --set-upstream origin <branch_name>

Go and create a new PR, and if it looks good, merge it. If it's a complicated change, make sure you have someone else to look at it as well.

Deployment

Currently using Heroku to deploy. Follow the tutorial to deploy the project. It is using the free tier service, which means it will die after 30 minutes of inactivity.


Make sure your changes are stable before deploying!!!

Get the latest master

git checkout master && git pull

Deploy to heroku

git push heroku master

Check it out

heroku open cool