atlp-rwanda/rca-phantom-team2-fe

# Phantom (frontend) Elevate the public transport experience # Description This project contatins codebase of the Phantom product which allows simulating bus movements and enabling passengers to track their locations & movements in Kigali. It intends to make daily Kigali Commute easy and convenient for the thousands of people who use public transport to move to and from different areas of Kigali. ## Setup Step-by-step instructions on how to get the code set up locally. ### Dependencies - NodeJs >= v16 - NPM >= v6 ### Getting Started List of steps to get started: 1. Clone the repository: `git clone github.com` 2. Checkout your preferred branch: `git checkout [branch-name]` 3. Install dependencies: `npm install` 4. Open in your browser: `localhost:3000` ### Run The Service Follow these steps to run the development or production servers: 1. Run `npm start` to start the development server 2. Run `npm run build` to build the project ## Testing Execute the command `npm run test` to run all tests ## Contribute After cloning and running the project successfully, follow these steps: - Create a new branch from `develop`. - Make changes in the new branch, commit, push and raise a pull request (PR). Please, adhere to the following rules and conventions here ## Deployment TBD