HMDA Edit Check API

This project is a work in progress

Nothing presented in the issues or in this repo is a final product unless it is marked as such.

Requirements

The project uses:

• NodeJS JavaScript on the server
  • KrakenJS Framework for convention over configuration and security
• MongooseJS Object modeling for MongoDB
  • Mockgoose Mocking mongoose connections for unit testing
• MongoDB Highly scalable document based NoSQL database

How to get this running or how to use it

First Steps

Make sure you have NodeJS installed (currently, version 0.10.33), and you can use the npm command:

$ npm version

Install Grunt globally:

$ npm install -g grunt-cli

Then install dependencies from the project root directory:

$ npm install

Running the tests:

$ grunt test

Running locally

Make sure you have a functional instance of MongoDB installed and running

$ mongo test
MongoDB shell version: 2.6.5
connecting to: test
> exit
bye

If your instance of MongoDB is installed somewhere other than your local machine, you will need to update config/sandbox.json and modify the mongoConfig section with your instance details.

Start the server with a grunt task:

$ grunt serve

This will make the application listen on localhost:8000 for requests, and will watch the source code for changes and reload the application as necessary.

Deploying

Make sure you have modified config/config.json with details about your deployment MongoDB instance in the mongoConfig section.

Now you can run a grunt task to build an archive of the application:

$ grunt dist

This task produces dist/hmda-edit-check-api.zip, which can then be deployed by your continuous integration platform, or manually deployed into your server environment.

Getting involved

For details on how to get involved, please first read our CONTRIBUTING guidelines. This project follows an adapted pull request workflow on top of GitHub, please consult the details before adding features to the project.

---

Open source licensing info

1. TERMS
2. LICENSE
3. CFPB Source Code Policy