Skip to content

Latest commit

 

History

History
executable file
·
34 lines (23 loc) · 1.06 KB

README.md

File metadata and controls

executable file
·
34 lines (23 loc) · 1.06 KB

React HSL Timetables

A web application for showing HSL timetables. Select your stop and view the next public transport scheduled to pass that stop.

Built with React and TypeScript. Runs with Vite.

Getting started

This project uses Node and npm.

  1. Set the VITE_API_KEY environment variable, for example in an .env.local file, see api registration to get a key.
  2. Install dependencies 
    npm install
  3. Start the development server 
    npm start
  4. Open http://localhost:3000

There is a pre-commit hook that runs prettier code formatting. Prettier can also be run manually using npm run prettier.

Tests

npm run test

By default, only tests that have changed since the previous commit are run. Running npm test will run in a watch mode and give options to e.g. run all tests.

Deployment

There is automatic deployment set up on pushes/merges to the main branch. It uses GitHub Actions to deploy to GitHub Pages.