Touhou Card Game (c) by Kailang Fu

Touhou Card Game is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

You should have received a copy of the license along with this work. If not, see http://creativecommons.org/licenses/by-nc-sa/4.0/.

---

Coverage status: https://coveralls.io/github/DotLab/touhou-card-game-nodejs

CI status: https://travis-ci.org/DotLab/touhou-card-game-nodejs

---

Main Contributors

• Kailang https://github.com/Kailang
• Enlne https://github.com/Enlne
• Kuobao https://github.com/Kuobao
• SirCharlie https://github.com/SirCharlie
• Danielczl315 https://github.com/Danielczl315
• BingXuhan https://github.com/BingXuhan

Development setup

Install NodeJS 10.x LTS: https://nodejs.org

Clone this repository:

git clone https://github.com/DotLab/touhou-card-game-nodejs

Go to the project root directory:

cd touhou-card-game-nodejs

Install back-end dependencies:

npm install

Install front-end dependencies:

cd app && npm install

Production build

Go to the project root directory.

Build front end:

npm run build-app

Run production server on port 3000. This server also serves front end.

npm start

Development commands

Enable debug log in console

Go to the project root directory.

To enable debugging console output, set environment variable DEBUG to tcg*. The following example is for Linux-like systems.

export DEBUG=tcg*

Start web app for development

Go to the project root directory.

Start back-end server on port 3000:

npm run debug

In another console, start CSS compiler:

cd app && npm run atomizer

In another console again, start front-end server on port 3001. When asked "Would you like to run the app on another port instead," say yes.

cd app && npm start

Now whenever any files are updated, the back end and front end will be restarted automatically.

Run end-to-end test using the development back end and front end

Start web app for development.

Set environment variable E2E_INDEX to http://localhost:3001. The following example is for Linux-like systems.

export E2E_INDEX=http://localhost:3001

Clear database:

node ./scripts/clearDatabase.js

Run selenium:

npm start e2e

Run end-to-end tests

Go to the project root directory.

Build front end:

npm run build-app

Run production server on port 3000. This server also serves front end.

npm start

Clear database:

node ./scripts/clearDatabase.js

Run selenium:

npm start e2e

Miscellany

Go to the project root directory.

Check formats:

npm run lint

Reformat:

npm run lint-fix

Run tests:

npm run mocha

Auto-rerun tests when code changes:

npm run debug-be

Check formats, run tests and generate coverage report:

npm test

Serve coverage report on localhost:

npm run serve-coverage

Generate JSDoc:

npm run jsdoc

Serve JSDoc on localhost:

npm run serve-docs

Git conventions

Start a new branch with name: <your-github-name-in-lower-case>-<feature-name-in-lower-case>

For example, if Kailang wants to add front end HTMLs for login, he needs to start a new branch named kailang-login-front-end.

Submit a Pull Request when you are done.