An API to drive disaster and emergency response systems.
We've included a docs folder with a template Tech Spec and Best Practices document, though using Github's Wiki capabilities is also a good idea. This will get you started with documenting your project. Other documents and relevant information that has no other place can live in the docs folder. Replace this paragraph with a brief breakdown of what you've included in your docs folder.
A Dockerfile and docker-compose file have been included for convenience, however this may not be the best local setup for this project. To work on this project you should have:
- NodeJS
- PostgreSQL (can be in Docker)
- Docker (optional) Once you have the prerequisite software installed you can proceed to setup this application.
You will need a PostgreSQL database running locally to run this application locally. You may setup PostgreSQL however you wish, however we recommend using Docker using the instructions found here: https://hub.docker.com/_/postgres
If you are using the Docker method you may spin up your database layer by running this command:
docker run -d -p 5432:5432 postgres
If you're running a database in another way then we trust you can sort it out on your own because you're awesome 😎
This application is designed to work as an API driven by Express. To setup your environment first you must install all required dependencies by running the following command from the root of your project directory:
npm install
Once all dependencies are installed you will need to setup some environment variables to interact with your database and application. To do that you may run:
touch .env
echo 'NODE_ENV=local
PORT=<your port>
ERASE_DATABASE=true
DATABASE=<your database name>
DATABASE_USER=<your database user>
DATABASE_PASSWORD=<your database password>' >> ./.env
You may use this product to create and manage users for your front-end. More to come!
To run the application--after the above steps are completed--run npm start.
To test your code you may write test cases to ./index.spec.js and then run the tests with npm test.
To check your linting you may run npm run lint and to format and automatically fix your formatting run npm run format.
We are also building a front-end application called Healthcare Rollcall to interact with this backend API. To view that project, or to contribute to it, please visit the repo here: https://github.com/CodeForBaltimore/Healthcare-Rollcall
We will be including multi-repo build processes with the front-end that will reference this project.
