README.md

TFL Journey Planner

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

• SpeedCodeProjects | Train Animation
  • The train animation was created by SpeedCodeProjects. I made some slight modifications to timing. The original animation can be found here
  

🛠️ 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.