Skip to content

Latest commit

 

History

History
69 lines (43 loc) · 1.92 KB

README.md

File metadata and controls

69 lines (43 loc) · 1.92 KB
Raw

eflow-client

Build Status Coverage Status

About

This project uses NodeJS, ExpressJS, Sequelize, and Postgres.

Getting Started

  1. Install NodeJS, npm, yarn and Postgres.

  2. Create dev and test database in Postgres

    psql;
CREATE DATABASE eflow_development;
CREATE DATABASE eflow_test;

  3. Install your dependencies

    cd path/to/eflow-api; npm install

  4. Start your app

    npm start

Testing

Simply run npm run test and all your tests in the test/ directory will be run.

CI

It uses Travis-CI and Coveralls.

Sequelize CLI

$ npm install -g sequelize-cli

$ sequelize model:create --name TodoItem --attributes content:string,complete:boolean #Generate a model

Help

For more information on all the things you can do with Sequelize CLI visit sequelize cli .

Scripts

"test": "NODE_ENV=test npm run test-prepare ; NODE_ENV=test npm run mocha", # Clear database before all the tests are run
"test-cover": "NODE_ENV=test nyc --reporter=text npm run mocha",             # Generate test coverage report locally
"test-coverage": "nyc report --reporter=text-lcov | coveralls",              # Generate test coverage and send it to Coveralls

Deployment

ssh into server, and re-build client directory.

License

Copyright (c) 2019

Licensed under the MIT license.