Tipsy Tourist

Tech · Spec · Installation · Running locally

Makers final engineering project created by Iain Hoolahan, Kay Watts, Tim Buller & Will Lines.

Tech

Spec

An app to plot a pub crawl whilst taking in the sights along the way!

Installation

Backend

Clone this repo

In terminal (Mac), run:

cd tipsy_tourist_server
npm install

You will need to request a Google API key here and then create a new file apiKey.js in the src directory with the following code:

const apiKey = "<YOUR-API-KEY>"
module.exports = apiKey

Frontend

Clone this repo

In terminal (Mac), run:

cd tipsy_tourist
npm install

Create a .env.local file in the root of the directory and add in this code:

REACT_APP_GOOGLE_MAPS_API_KEY= "<YOUR-API-KEY>

Running locally

Backend

cd tipsy_tourist_server
npm start

Frontend

cd tipsy_tourist
npm run build
serve -s build

Open http://localhost:3000 to view the app in your browser.

Demo

Tipsy Toursit has a single page with 4 main components (map, search bar, itinerary, location details). When you first land on the website you will see the map component which fills the screen and a search bar which provides many options for the user to tailor their requirements before searching.

Once the user has provided a start-point, end-point, number of pubs/attractions and clicked the search button the route will be displayed on the map with an itinerary at the bottom.

The user can click on any of the locations in the itinerary to find out more details.