bestnest-api
Read this to get started with the project. See also our API documentation
installation
$ git clone [email protected]:codeforamerica/bestnest-api.git && cd bestnest-api
$ npm install
You'll also have to have some environment variables defined. You can get started by
copying env.example
$ cp env.example env
In production, use whichever method you like best for managing environment variables,
e.g. Heroku config:set
running
$ source env
$ npm start
environment variables
PORT
- the primary web port to bind toDB_CONN_STR
- a mongodb connection urlURL_ROOT
- the URL and forward slash that the server is listening on (eghttp://localhost:9001/
)
database
this app combines data from many sources. unfortunately, not all of these sources are yet available publicly (although our longterm goal is to change that, making them available as open data). Unfortunately, this makes running the app with live data from outside of Code for America more difficult. Please contact us in a github issue if you would like to get this project set up and running.
framework
bestnest-api
is build using the
express 4 framework
contributing
Pull Requests are welcome. Development is discussed in Github Issues and on IRC.
Test and deployment spam and other notifications are pushed into IRC at
irc://irc.freenode.net/cfacha
.
The primary client for this API is rentfacts-app. Relevant discussion and background may also be located in that repo.
Please also see CONTRIBUTING.md
for community contribution guidelines.
license
(c) MMXIV Code for America. ISC license.