Skip to content

wangc9/journey-reviewer-frontend

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Journey Reviewer

Review the past journeys made by shared bike in the HSL region
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. License
  5. Contact
  6. Acknowledgments

About The Project

Product Name Screen Shot

This is the frontend implementation of the journey reviewer web.

(back to top)

Built With

  • Vite
  • React
  • Redux
  • React-Router
  • MaterialUI
  • Firebase
  • Eslint
  • Prettier
  • Jest
  • Testling-Library

(back to top)

Getting Started

This frontend is going to be deployed online. However, you could still clone the project and try it locally.

Prerequisites

In order to run this project locally, Node.js is needed. If you haven't installed it on your own device previously, have a look at the offical website https://nodejs.org/en/download and install it first

To build the backend on your own device, first clone this project into your device

git clone https://github.com/wangc9/journey-reviewer-frontend.git

Installation

  1. At the root directory, install all the dependencies used in this project

    npm install
  2. Follow the instructions from the corresponding backend to run the backend locally first.

  3. Run the project in a new terminal with

    npm start

    Note: the backend should be kept on the whole time

  4. This project follows the Test-driven Development (TDD) practice. To run all the tests for this project, use

    npm run test

(back to top)

Roadmap

  • Manually adding stations
  • Drag and drop data files

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Chen Wang - @twitter_handle - [email protected]

Project Link: https://github.com/wangc9/journey-reviewer-frontend

(back to top)

Acknowledgments

(back to top)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published