Public | Automated Build

Last pushed: a year ago
Short Description
Open311 API written in node
Full Description

Build status



Node.js, Express, Sequelize.


Windows specifics


From a console or terminal:

git clone
cd open311-api
npm install .

Make sure you have a mysql database available

Create a file called config.json

Note: you can copy config.default.json to config.json to get hints on the required variables.

Make sure you have the correct mysql credentials set up for your local mysql installation. The scripts will not
create any databases so make sure you have created the required databases before starting or running tests

Run the tests

npm run migrate:test
npm run seed:test
npm test

Run the Application

To start the application in "development mode":

npm start

To start the application in "production mode":

export NODE_ENV=production && npm start

Or, using forever:

NODE_ENV=production /usr/bin/forever start -c "npm start" /path/to/open311-api/

Point your browser to http://localhost:3000/api/v2/services.json to check if the application is running.

Docker Pull Command
Source Repository