Phantom

Maintainability Badge

CI/CD

Coverage Badge

Tests

Description

Phantom is an application that allows simulating bus movements and enabling passengers to track their locations & movements.

Gettingstarted
Settingup
Installation
Collaborators
License
Badges
Features
Contribute
Tests

Gettingstarted

To run this project, you’ll need to install node 5 and above. The latest version of Node.js is recommended. The dependencies of this project are managed with yarn (see installation guide here). However you can simply use the node package manager, npm for your dependency management.

Settingup

Clone this project to any folder on your local machine

git clone https://github.com/atlp-rwanda/phantom-be-dream-team

Navigate into the folder name specified

cd phantom-be-dream-team

Installation

For those who love NPM

npm install

Runnning_the_bundle

 npm run dev:start

Running_the_app_in_Development

Run npm run dev:start to intialize and run the webpack development server. Navigate to http://localhost:3000/. The app will automatically reload if you change any of the source files.

Running_the_app_in_Production

To run the app in production build of the app, use either of the following.

 npm start

Running_the_Migrations

 npm run migrate

Running_the_Seeds

 npm run seed

Documentations

migrations and seeding with sequelise

Running the docker container

 npm run dockercompose

Running postgres in docker container

 docker run -it -e "POSTGRES_HOST_AUTH_METHOD=trust" -p 5432:5432 postgres

atlp-rwanda/phantom-be-dream-team