Git Product home page Git Product logo

mayansites's Introduction

Contributors Forks Stargazers Issues GNU License LinkedIn


Logo

Over 6000 Mayan Sites

Dashboard to explore a map of over 6000 Mayan sites
Explore the docs »

View Live 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

Dashboard with a map of over 6000 mayan sites, graded by quality of site. Selecting a site brings info about it. Also a video exploring the site will be found, photos of the site, and even a site layout if available.

(back to top)

Built With

  • Plotly
  • Bootstrap

The advantage of using plotly is everything from the front-end to the back-end is built using python. No need to learn javascript and seamlessly put online with https://pythonanywhere.com (free account to get you going). Pythonanywhere has most python packages installed on their own side so you just need to put your .py file and it should run straight away.

(back to top)

Getting Started

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

Prerequisites

Install Python (better to use Anaconda https://www.anaconda.com/)

Installation

  1. Clone the repo
    git clone https://github.com/gkennaugh/mayansites.git
  2. Install required packages from requirements.txt
    pip install -r requirements.txt
  3. Run python app.py in a new Anaconda Command Prompt (can take one minute to fully run first time)
    python app.py
    Open the app in your local browser at http://localhost:8062

N.B. You can use my api key to begin with but please get your own free key here https://www.mapbox.com/

(back to top)

Usage

Explore mayan sites, their grade quality, images and video from the site. Also includes the tren maya route to see where stations might be close to Mayan archelogical sites.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • [-] Map info (location of mayan sites)
  • [-] Info on the site
  • [-] Youtube videos and photos
  • [-] Route of the tren maya

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 GNU General Public License v3.0. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @twitter_handle) - [email protected]

Project Link: https://github.com/gkennaugh/mayansites

(back to top)

Acknowledgments

(back to top)

mayansites's People

Contributors

gkennaugh avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.