Light-Rail-Radar

A progressive web app (PWA) to quickly look up the estimated time of arrival (ETA) of Hong Kong Light Rail on your phone.

Hosted on Netlify: https://lightrailradar.netlify.app

This project is started due to the lack of convenient ways to look up the next train of Hong Kong Light Rail. Many physical overhead displays in Light Rail platforms were taken down when MTR tried to streamline the look-up feature into its MTR Mobile app, but it failed miserably since the app is extremely inconvenient to use with a complicated UX and slow response time.

This progressive web app aims at providing the quickest and easiest way possible to look up the next light rail from your mobile.

Bootstrap

This project was bootstrapped with Create React App.

UI Framework

This project uses Chakra UI component library.

Getting Started

To get started with building this project from scratch, follow these steps:

Prerequisites

Make sure you have the following installed on your development machine:

• Node.js (version >= 18)
• Yarn (version >= 1.22.22)
• Git

Clone the Repository

First, clone the repository to your local machine using Git:

git clone https://github.com/LaurenceLungo/Light-Rail-Radar.git
cd Light-Rail-Radar

Install Dependencies

Install the necessary dependencies using Yarn:

yarn install

Running the Development Server

To start the development server, run the following command:

yarn start

This will run the app in development mode. Open http://localhost:3000 to view it in the browser. The page will reload if you make edits, and you will also see any lint errors in the console.

Running Tests

To run the test suite in interactive watch mode, use:

yarn test

For more information on running tests, see the section about running tests.

Building the App for Production

To build the app for production, use:

yarn build

This will create an optimized build in the build folder. The build is minified, and the filenames include the hashes. Your app is ready to be deployed!

For more information on deployment, see the section about deployment.

Ejecting the App

Note: this is a one-way operation. Once you eject, you can’t go back!

If you need to customize the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project:

yarn eject

This will copy all the configuration files and transitive dependencies (webpack, Babel, ESLint, etc.) into your project so you have full control over them. At this point, you’re on your own. You don’t have to ever use eject, but it’s available if needed.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

yarn build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify