Skip to content

Latest commit

 

History

History
98 lines (54 loc) · 2.1 KB

README.md

File metadata and controls

98 lines (54 loc) · 2.1 KB
Raw

Orbit-server

Orbit-server is the back-end for Orbit , an open-source data visualisation tool that allows businesses, sports teams and educational institutions track, measure and improve performance. Built using cutting-edge technologies, Orbit provides a birds-eye-view on performance metrics in a way that is easy to understand and digest. Students, players and employees are presented with key changes they can make to improve the performance through a complex neural networks, helping users focus their time more effectively and efficiently.

Tech Stack:

Front-end:

  • React
  • Redux
  • Webpack
  • D3.js
  • VX.js
  • PostCSS

Back-end:

  • Koa
  • MongoDB
  • MongoLab
  • Travis CI
  • Heroku

Using Orbit-server

A few things you have to take in consideration before using Orbit-server

After cloning the repo you'll have to :

Install global and local dependancies:

  • NPM

  • Node

Two options using the database

1. You use an online database

In this case you should:

  • Create a free account at mLab
  • Create a .env file containing:
DB_USERNAME=YOUR_DB_USERNAME
DB_PASSWORD=YOUR_DB_PASSWORD
DB_HOST=YOUR_DB_HOST
DB_PORT=YOUR_DB_PORT
DB_NAME=YOUR_DB_NAME

Connet to Database

In the shell type:

$mongo YOUR_DB_HOST.mlab.com:YOUR_DB_PORT/YOUR_DB_NAME -u YOUR_DB_USERNAME -p YOUR_DB_PASSWORD

2. You can use your local database

In this case you should:

  • In the db.js-file uncomment the section marked as 'LOCAL DATABASE' and comment out the section marked 'ONLINE DATABASE'

Connet to Database

In the shell type:

  • $mongod
  • $mongo (In another tab)

Start the server

In the shell type:

$npm start

Happy hacking!!

Use Postman for HTTP requests

Use this link to get all requests: Orbit end-points.

Don't forget to create a new Environment (http://localhost:3000).