Code Monkey home page Code Monkey logo

xhemals / tfl-journey-planner Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 295 KB

The TFL Journey Planner is a web application that utilises the Transport for London Unified API to deliver accurate and efficient route planning. It also incorporates the Postcodes.io API for search autocomplete and validation, thereby enhancing user experience.

Home Page: https://xhem.al/tfl-journey-planner

License: MIT License

JavaScript 90.53% CSS 3.12% SCSS 6.35%
react route-planning tfl-api

tfl-journey-planner's Introduction

TFL Journey Planner

React License: MIT GitHub Actions Workflow Status

Live Demo: https://xhem.al/TFL-Journey-Planner/

The TFL Journey Planner is a web application that utilises the Transport for London Unified API to deliver accurate and efficient route planning. It also incorporates the Postcodes.io API for search autocomplete and validation, thereby enhancing user experience.

This application is optimized for mobile use.

๐Ÿš€ Getting Started

To set up a local copy of the project, follow these steps:

Prerequisites

  • Node.js
    • Download and install Node.js from the official website. This will also install npm.
  • npm
    • npm comes bundled with Node.js. Hence, downloading Node.js automatically installs npm on your computer.

To verify if Node.js is installed, execute this command in your terminal: node -v

Installation

  1. Clone the repository
    Execute the following command to clone the repository to your local machine:
    git clone https://github.com/xhemals/TFL-Journey-Planner.git

  2. Navigate to the project directory
    Switch your current working directory to the cloned repository.

  3. Install the required NPM packages
    Execute the following command to install all the necessary NPM packages for the project:
    npm install

๐ŸŽฎ Usage

To start the development server, execute: npm run dev

To build the project for production, execute: npm run build

๐Ÿ“ธ Screenshots

๐Ÿ† Credits

๐Ÿ› ๏ธ Built With

๐Ÿšง Roadmap

Here are some upcoming features:

  • Style the output from the route planner API properly
  • Addition of a feature to save favorite routes.
  • Capability to share routes with others.

๐Ÿ“œ License

This project is licensed under the MIT License. See LICENSE for more details.

tfl-journey-planner's People

Contributors

dependabot[bot] avatar xhemals avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.