Skip to content

MiVladie/journeyplanner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌸 About

A Journey Planner will plan your next journey in London using entered origin & destination places.

Website preview: https://mivladie.github.io/journeyplanner/

📝 Table of Contents

🚀 Quick Start

You must have installed all of the software applications in the installation section.

Quick start guide to set the server up and running.

Step 1: Installing the dependencies

Run npm install

Installs all of the necessary dependencies.

Step 2: Setting up configurations

Google Maps

  • Open /src/config/constants.js file;
  • Assign the API key to the GOOGLE_MAPS_API_KEY constant;
  • Save the file.

Transport for London

  • Open /src/config/constants.js file;
  • Assign the TLF ID & TLF KEY to the TFL_APP_ID & TFL_APP_KEY constants;
  • Save the file.

Step 3: Launching the server

Run npm start

Starts the server in the development mode.

🖥️ Installation

In order to run the server, you must have installed all of the necessary software listed below.

NodeJS

Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.

⌨️ Available Scripts

In the project directory, you can run:

npm install

Installs all of the necessary dependencies.

npm start

Runs the app in the development mode on port :3000.

npm run build

Builds the app for production to the /build folder.

📗 Learn More

References to the packages used in the project.

ReactJS

React is a JavaScript library for building user interfaces.

React Google Maps

react-google-maps provides a set of React components wrapping the underlying Google Maps JavaScript API v3 instances.

React Places Autocomplete

A React component to build a customized UI for Google Maps Places Autocomplete

Sass

Sass is a preprocessor scripting language that is interpreted or compiled into CSS.