Skip to content

Latest commit

 

History

History
192 lines (137 loc) · 5.97 KB

README.md

File metadata and controls

192 lines (137 loc) · 5.97 KB
Raw

Logo

Mapty

A Map application made with JavaScript to store workouts.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

image

Mapty is a vanilla JavaScript application that interacts with the Leaflet library and display Map. This app uses modern JavaScript tools, such as Webpack to bundle the modules, and Babel to convert ES6, ES7 and ES8 back to ES5. The user can add workouts for running and cycling and these are stored via local storage.

Built With

This app is built with pure vanilla JavaScript along with HTML and SCSS. It uses webpack as module bundler and NPM as package manager.

Getting Started

To get started with project just simply fork this repo or download locally on your System.

To get a local copy up and running follow these simple example steps.

Prerequisites

Start with the latest version of NPM to avoid any errors:

  • npm 
    npm install npm@latest -g

Installation

  1. Get Leaflet library Leaflet
  2. Clone the repo 
    git clone https://github.com/vinayak0127/Mapty.git
  3. Install NPM packages 
    npm install

Usage

  1. Add workouts near to your Geo location.

  2. Add workouts to bookmarks to view it later.

  3. Click on workouts to see it's location.

Roadmap

See the open issues for a list of proposed features (and known issues).

Proposed features

  1. Ability to edit a workout.

  2. Ability to delete a workout.

  3. Ability to delete all workouts.

  4. Ability to sort workouts by a certain field (e.g. distance).

  5. Re-build Running and Cycling objects coming from Local Storage.

  6. More realistic error and confirmation messages.

  7. Ability to position the map to show all workouts.

  8. Ability to draw lines and shapes instead of just points.

  9. Geocode location from coordinates (“Run in Shoghi, Shimla).

  10. Display weather data for workout time and place.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Vinayak Raj - Say Hie

Project Link: https://github.com/vinayak0127/Mapty

Acknowledgements