yrevocnu / psychedelic-glass-bead-game

1 stars 2 forks source link

Development

  1. Install node via nvm
  2. Install Yarn
  3. Install Mongo Community Edition
  4. Move .env-sample to .env and replace DISCORD_TOKEN (ask @benheller)
  5. nvm install <-- select node version
  6. yarn install <-- install deps
  7. E.g. sudo service mongod start if running mongo locally
  8. yarn seed:db <-- seed db
  9. yarn debug <-- run app

Contributing

  1. Run yarn eslint . prior to committing code and address all enumerated issues.
  2. Commits should be squashed and rebased when merging PRs. No merge commits.
  3. PRs are encouraged and require 1 approval to merge.

Commands

  1. !new <-- starts new PGBG session
  2. !draw <-- lists decks
  3. !draw {{deck}} <-- draws a card in a deck

MongoDB

  1. There are scripts for reseeding the database. Be careful not to do this with the production DB! (even if you have the .env for it)
  2. You will need to have the MongoDB running locally if you want to seed it, with something like
    sudo service mongod start

Cards

The card data is is assets/decks.

There is a .csv file for each deck with all the card data with its spellings.

The directories contain the images of the cards. (Referenced by the decl .csv files)