Skip to content

Latest commit

 

History

History
51 lines (41 loc) · 1.46 KB

README.md

File metadata and controls

51 lines (41 loc) · 1.46 KB
SplitMATE API
Split and manage anything you want with your mates

Master CI Quality Gate Status

Splitmate API

Requirements

  • NodeJS
  • MongoDB
  • Postman (for testing using samples located at requests/)

Configuration

  1. npm install
  2. Add .env-cmdrc file into the project directory.
{
  "dev": {
    "PORT": "3000",
    "MONGODB_URI": "mongodb://127.0.0.1:27017/splitmate-api",
    "JWT_SECRET": "[SECRET_HERE]",
    "SENDGRID_API_KEY": "[SENDGRID_API_KEY]",
    "SENDGRID_MAIL_FROM": "[email protected]",
    "SENDGRID_INVITE_TEMPLATE": "[SENDGRID_INVITE_TEMPLATE_ID]",
    "SENDGRID_REMINDER_TEMPLATE": "[SENDGRID_REMINDER_TEMPLATE_ID]",
    "SWITCHER_API_KEY": "[SWITCHER_API_KEY]",
    "SWITCHER_API_URL": "https://switcher-load-balance.herokuapp.com",
    "SWITCHER_API_OFFLINE": "true"
  },
  "prod": {
  },
  "test": {
  }
}

How to colaborate

  1. Open an issue describing your contribution
  2. Fork, build, test, and submit your PR