Augur Node is designed to be a standalone application, including a local database setup that supports sqlite as well as postgresql. We use knex to manage the local migrations and schema changes.
If you just wanna get up an running quickly there is a one-click heroku deployment option.
This project uses typescript and can be safely built via: npm run build or directly with tsc
Migrations are managed via knex and behave similarly to ActiveRecord migrations. As you add migrations, knex tracks the currect applied state in the database, and allows you to apply new migrations as they come in.
See: [http://knexjs.org/#Migrations-CLI]
New migrations are in typescript and are store in: src/migrations/
To use the knex tool to generate a migration in this directly, use the development enironment:
knex migrate:make -x ts --env development name
Make sure your typescript is built before running migrations
knex migrate:latest --env build
Seed files are used to seed the test database. Unlike migrations, seeds are meant only for boostrapping, and so each time seeds are run all the source files are executed (not just newly added ones). Currently the seeds files drop and re-create the tables with each application.
Seeds are stored in src/seeds/<environment>/*.ts.
See: [http://knexjs.org/#Seeds-CLI]
This is similar to creating new migrations, but only one should exist per table for clarity.
knex seed:make seed_name --env development
knex seed:run --env build
Tests run with in-memory SQLite DBs for each test execution so they won't overlap each other. The framework will automatically initialize and seed the tests with the data in seed/test for each test.
npm install
npm run build
npm test