redadalertas-api

A public API for the web app, and mobile apps to consume.

redadalertas-api

A public API for the web app, and mobile apps to consume.

Welcome

If you are reading this, thanks for stopping by. You may be familiar with the Redadalertas project.

This project is part of that. This repo will house the code to make the public facing API.

API Documentation

https://cosecha.github.io/redadalertas-api/

Dependencies

Make sure you have the following installed on your computer

  1. Node.js
  2. Yarn
  3. Git
  4. Mongo

Development Setup

  1. Clone the repository

  2. Setup the environment variables in the / directory: cp src/.env.example src/.env

  3. Install node modules in the /src directory, we recommend using Yarn: yarn in the /src directory

  4. Run MongoDB service: brew services start mongodb

  5. Update the MongoDB database: yarn run bootstrap in the /src directory

  6. To shut down server: Ctrl + c in server terminal

  7. To shut down database: brew services stop mongodb

Scripts

  • yarn start: starts the server (also npm start)
  • yarn test: performs testing (also npm test)
  • yarn run lint: runs the linter (also npm run lint)
  • yarn run bootstrap: populates your local mongo db with sample data (also npm run bootstrap)

Related Repositories

redadalertas-api

redadalertas-api

A public API for the web app, and mobile apps to consume. ...