Skip to content

atlp-rwanda/Phantom-Frontend-Elites

Repository files navigation

Development workflow Maintainability Test Coverage

Phantom-Frontend-Elites

Description

This is an application under development and it's aimed at mitigating and reducing the waiting Time that passengers spend on bus stations while waiting for buses. It is being built as a team project by Code Elites Team through the Andela Technical Leadership Program. Therefore this Readme is build to show people who might not be familiar with the syntax in React how to create and import components, make an api call, and render other functionalities.

Installation and run commands

  • Clone the repo in your terminal by clicking the green clone or download button at the top right and copyin the url

  • In your terminal, type git clone URL

    • replace URL with the url you copied
    • hit enter
  • This will copy all the files from this repo down to your computer

  • In your terminal, cd into the directory you just created

  • Type npm install to install all dependencies

  • Add a .env file in the project directory and this should include all the environment variables, so far only have PORT (this is equel to the port number eg. 4000)

  • Last, but not least, type npm run dev to run the app locally.

  • To look at the code, just open up the project in your favorite code editor!

  • To have a good experience with this project. You can also install Redux DevTools. This is Google Chrome extension which provides power-ups for any architecture tool which handle the state. For our project it will help in our Redux development workflow and debugging application's state changes. Use is this link to install this extension in your Google Chrome.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published