The actual REST API server source code is located under src/app
. The REST API
server currently is deployed in Heroku http://evulse-express-api.herokuapp.com/
To run the app on local environment just follow this steps:
-
Import the MySQL dump to your local MySQL server, the MySQL dump is located on
src/database/express-api-boilerplate-dev.sql
-
Start the app by run server, go to directory
src/app/
and runforeman start
REST API documentations is located on https://evulse.atlassian.net/wiki/display/EOAB/REST+API+Documentation
This project is setup through CircleCI. Build Status Images will be added soon.
Test is located under test
. Currently, the test is only covering the REST API
end point test. To run the test follow this steps:
-
Setup the environment by run this command
export NODE_ENV=testing
. Currently, the test runner is only run best in Ubuntu 12.10. -
Start the MySQL database with database name
circle_test
, usernameubuntu
and leave the password empty. -
Run
npm test