tl;dr -> develop with npm run tdd
and npm run tdd:int
, use npm run dev
to run local environment.
To have image uploads working locally you'll need a valid aws key/secret pair. Run it like so:
IMAGE_UPLOAD_ACCESS_KEY_ID=ACCESSKEYHERE IMAGE_UPLOAD_SECRET_ACCESS_KEY=SECRETKEYHERE npm run dev
To have email notification working locally you'll need a valid aws key/secret pair. Run it like so:
SES_ACCESS_KEY_ID=ACCESSKEYHERE SES_SECRET_ACCESS_KEY=SECRETKEYHERE npm run dev
Ensure any database migration is backwards compatible with a previous version of the api. This will keep deployments simple and clean.
ENV={ENV} npm run migrate
Starts a database container and exposes it to 127.0.0.1:3306
npm run mtr-prepare
Runs the migration against the test database. Make sure to have your migrations written in src/migration/scripts
, with the db models in their origin (pre-migrated) state in src/lib/models
.
npm run mtr
Run after running test migration to roll back changes.
npm run mtr-revert
Deployments to production are triggered by tagged commits, tag with npm version major|minor|patch
. Deployments to test are done adhoc and are almost manual.
Like to contribute? Look at the issues tab or contact me on reddit or twitter to find something you'd like to work on, then make a pull request against the master
branch.
© 2015-present gw2armory.com