8000 GitHub - celsom3/redadalertas-api: A public API for the web app, and mobile apps to consume.
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

celsom3/redadalertas-api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 (latest)
  2. Yarn
  3. Git
  4. Mongo
  5. Xcode Command Line Tools: xcode-select --install (required to properly install the bcrypt package)

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. Start server: yarn start in the /src directory

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

  8. 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)

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%
0