Skip to content

Latest commit

 

History

History
63 lines (50 loc) · 1.64 KB

README.md

File metadata and controls

63 lines (50 loc) · 1.64 KB

jogging-tracker

jogging tracker is a RESTful API app made to track jogging times.

Task analysis

Task analysis Document

Database design

Database design schema

ERD

API Documentation

Run the server on development mode then go to the link bellow

http://localhost:<port>/docs

Local Setup

  1. Install Node.js

  2. Install MongoDB

  3. Install git

  4. Clone the repository

$ git clone https://github.com/IslamGoher/jogging-tracker.git
  1. cd to the repository directory
$ cd jogging-tracker
  1. Install dependencies
$ npm install
  1. Create .env file, and add Environment Variables to it using nano:
$ nano .env
  1. Run the server

for development environment

$ npm run dev

for production environment

$ npm run build && npm start

Environment Variables

  1. PORT = ${port number that server will running on}, example: 3000
  2. JWT_SECRET = any string secret, example: my secret
  3. PG_USER = username of postgres server, example: postgres
  4. PG_PASSWORD = user password of postgres server, example: 123456
  5. PG_HOST = domain name of postgres server, example: localhost
  6. PG_PORT = the port that postgres server running on, example: 5432
  7. PG_DB = database name that wanted to connect with, example: postgres