Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 1.93 KB
Raw

Running the server

Basic demo

docker run -p 3000:3000 ryan3r/mazelike

Persistant changes

docker volume create mazelike
docker run -p 3000:3000 -v mazelike:/data ryan3r/mazelike

Testing

Run npm test in the tests directory. You will also have to run npm install in the tests directory. If you don't want to download chrome for the browser tests define PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=1 (powershell $env:PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=1)

The server will need to be running in order to run the tests.

VERSION

Our versioning follows the semantic versioning guidelines found here.

Generate documentation

Run npm run doc

Migrations

  • Run npm run migration:create "name-of-migration-here" to generate a skeleton migration
  • Run npm run db:migrate to migrate changes into the database
  • Run npm run db:migrate:undo to undo previous migrations

The DB variable

The db variable uses a url to specify the database connection information.

For mysql the format is mysql://username:password@host:port/database. If you exclude the port it is assumed to be 3306.

For sqlite it takes the form of sqlite://path/to/db. For a relative path just use sqlite:// + the path. For example sqlite://mazelike.sqlite refers to the file mazelike.sqlite in the current directory. If you want to use an absolute path you can do that with 3 slashes (e.g. sqlite:///root/db = sqlite:// + /root/db). On windows if the first path segment of an absolute path is a singe letter it is used as the drive letter. So sqlite:///d/foo would refer to D:\foo (/ are substituted for \ automatically). If the first segment is more than 1 letter it is assumed to be on the C drive. Therefore sqlite://foo would refer to C:\foo.

Default .env

DB=mysql://root:password@mysql/mazelike