Kajoo Dashboard
Installing
Requirements
Run yarn global add nodemon knex eslint bower apidoc jacu foreman
.
Also make sure you have:
- PostegreSQL
v.9.5
- Redis server
v.3.2
- node
v4.x
Run yarn run migrate
for the migrations.
Running
Copy .env.example
to .env
replacing the informations with the correct ones.
Run yarn && bower install
.
Run yarn start
in order to serve the application.
Testing
Run yarn test:server
in a console tab and then yarn test
on another one.
Deployment
-
Staging - Any commit on
master
deploys to staging env -
Prod - Manual approval through
CircleCI
interface
To specify an environment before (or after) push it to master
:
Functional releases
npm run deploy prod tagName [tagMessage] [envName]
Tests
npm run deploy test [envName]
envName = staging
if not specified
Documentation
Run yarn run docs
. This will generate a documentation folder apidoc
.
License
All rights reserved (c) 2016 Kajoo Sistemas de Informática Ltda.