/jogging-tracker

Primary LanguageTypeScriptMIT LicenseMIT

Jog Tracker

Jog Tracker is app build for jogger to keep track of daily progress and see aggregated statistics. The interface is clean, clear and is easy to use from the moment you first start using the app.

Table of Contents

Get Started

# setup (once)
npm install

# build
npm run build

# start
npm start

# run unit tests (make sure API is running)
npm test

# run e2e tests
npm run e2e

# run in development mode
npm run develop

# individual unit test
npm run test:server
npm run test:ui

URLs

Database Requirement

This setup requires an instance of MongoDB to be running in the local machine at default port. Alternatively you can configure a DB of your own - modify conf/app-conf.prod.json (for production) & conf/app-conf.dev.json (for development)

{
  "database": {
    "url": "mongodb://localhost/jog-tracker"
  }
}

Tools and Libraries Used

PURPOSE LIBRARY
View Library ReactJS
State Management StateX
CSS (Functional) Tachyons
CSS Processor SaSS
AJAX Library Axios
Transpiler TypeScript
Packaging WebPack
Database MongoDB
API Library Mongo Restifier
Web Framework Express
Object DB Modeling Mongoose
Test Suites Mocha
Assertion Library Chai
React Testing Library Enzyme
End to End Testing TestCafe
Code Coverage Istanbul

Features

Sign Up

SignUp

Sign In

SignUp

Dashboard

Dashboard

Jog Logs

Jog Logs

Make An Entry

Make An Entry

Manage Users (Admin and Manager)

Manage Users

Create User (Admin and Manager)

Create User

Manage User's Log (Admin Only)

Manage User's Log

API Documentation

API Documentation

Tests

Unit Tests - Front End

Ui Tests Ui Test Summary

Functional Tests - Back End

Server Tests

End to End Tests

End To End Tests

Author

Rinto Jose (rintoj)

Read my blogs at Medium.com

Follow me: Github | Facebook | Twitter | Google+ | Youtube