TimeTrack API

Is a set of tools to help the FrontEnd developer in the making of a portal alike toggl, the project was developed under nodejs with Typescript, Express and MongoDB.

Documentation

The documentation was build with Swagger - swagger-jsdoc and the link is the following:
https://qrvey-js-time-tracker.herokuapp.com/api-docs/

Installation

Installing TimeTrack API Locally

First download the project and run the following command.

  $ npm install

Start the server:

  $ npm start

Deploy the API on Heroku

1. Install the Heroku CLI
2. If you haven't already, log in to your Heroku account and follow the prompts to create a new SSH public key.

  $ heroku login

3. Clone the repository

  $ heroku git:clone -a qrvey-js-time-tracker
  $ cd qrvey-js-time-tracker

4. Deploy your changes

  $ git add .
  $ git commit -am "make it better"
  $ git push heroku master

Run Tests

  $ npm run test

Important: Ensure the packages Nodemon, Ts-node and Typescript are under the dependencies node in the package.json, NOT in devDependencies

Tests Results

The following screenshots are the results of the tests prior to the deploy on heroku, these tests were made with Jest and Supertest.

General - /

Root - /src

DTO - /src/DTO

Bussiness - /src/bussiness

Connectors - /src/connectors

Controllers - /src/controllers

Middleware - /src/middleware

Models - /src/models

Routes - /src/routes

Services - /src/services

Utils - /src/utils

Author: Julian Samper