Plan My Walk is a mobile friendly web application with configurable map elements, developed for planning walking routes. Ideally, a walker could access a map and at the same time check for issues affecting the potential safety and enjoyment of a specific walking route, such as weather. Plan My Walk attempts to bring together the most commonly needed types of information not found on a map to support walk planning.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
Plan My Walk was originally built as a final year student project for a BSc Computing and IT course. The original application was written in JavaScript, HTML and CSS. This project takes the design and functionality of the original and further develops it as a modern React.js application.
Currently, Plan My Walk displays an interactive map centred on the United Kingdom and can use geolocation. The drawing, route matching and weather reporting used by the original application will also be features in this version.
This is an example of how you may set up your project locally. To get a local copy up and running follow these steps.
- Node Visit Node.js and select the appropriate download for your system.
- Clone the repo
git clone https://github.com/snowyPigeon/plan-my-walk.git
- Install NPM packages
npm install
- Enter your Mapbox environment token in an env.local file.
REACT_APP_MAPBOX_ACCESS_TOKEN = "your-token-here"
- Enter the address for your choice of map style either in an env.local file or in the Map.js.
Remember to run npm run start after saving your env file, when previewing your work.
To run a development version of this project, you will need to:
- Run the plan-my-walk server by navigating to that directory on your machine's CLI in a new window/tab. Checkout the appropriate branch and run
npm run. - Run the compile:sass script by navigating to the plan-my-walk directory on your machine's CLI in a new window/tab. Checkout the appropriate branch and run
compile:sass. This will allow live updates to the style sheet based on instructions written in the src/scss directory.
- Feature 1 Route drawing
- Feature 1 Route matching
- Feature 3 Weather reporting
Distributed under the GPL-3.0 License. See LICENSE.txt for more information.
Your Name - @twitter_handle - email@email_client.com
Project Link: https://github.com/snowyPigeon/plan-my-walk
