/cruise-control-api

Time and goals management REST API

Primary LanguageJavaScript

Cruise Control API

Time Management REST API. Work in Progress. For the Front End side of this, look at this repo.

Dependencies

  • Node
  • Mongo DB

If you're using a Mac, using Homebrew is heavily recommended. Use previous link for official install instructions. Follow these very simple --official-- instructions to install MongoDB using the Brew package manager.

Setup

Environment File

  • Create a file in the --root-- of your project --named-- .env.
  • Copy/paste the following snippet to your file
  • Make sure to change the values to match your local development environment.
MONGO_LOCAL_CONN_URL=mongodb://127.0.0.1:
MONGO_LOCAL_MD_PORT=27017/
MONGO_DB_NAME=social_clubs_db
ACCESS_TOKEN_SECRET=addjsonwebtokensecrethere
REFRESH_TOKEN_SECRET=notsosecrettoken
PORT=8000

-These are sample values, make sure to change as needed.- The PORT key at the bottom represents the port where the API will run on your localhost, not the database.

Usage

npm run start

Notes

The extras folder holds a postman collection you can import to test the endpoints.

Folder Structure

To be continued...