/TripDisplay

Primary LanguageJavaScript

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Trip Display

A gaphical display showing destinations on the 2021 roadtrip taken by my fiance and myself, with plans to eventually expand this into a travelling social network where users can share their trips.
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. Acknowledgments

About The Project

Product Name Screen Shot

(back to top)

Built With

(back to top)

Getting Started

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

Prerequisites

You will need the npm version 6.14.15 or later.

Installation

  1. Clone the repo
    git clone https://github.com/Kayos113/TripDisplay.git
  2. Install NPM packages
    npm install
  3. Run the server
    npm start

(back to top)

Usage

This project is being developed as an anniversary gift, to eventually be expanded into a social network for travelers to share their trip itineraries with one another.

(back to top)

Roadmap

  • Leaflet map integration
  • Leaflet routing machine integration
  • Map out initial trip, stop coordinates.
    • Nested Feature

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

License

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

(back to top)

Contact

Your Name - @Kayos_113 - willyknapp@gmail.com

Project Link: https://github.com/Kayos113/TripDisplay

(back to top)

Acknowledgments

(back to top)