Vegan Places in India on the Map!

Complete Documentation at:

https://sejal27.github.io/Indian-Vegan-Places/

Table of Contents

• Background
• Author
• Tools, APIs and Frameworks
• How to Use
• Source Files
• Javascript Documentation
• License

Background

A list of selected vegan places in India, displayed on Google maps. Displays Zomato rating, and other place information when clicked.

Author

Sejal Parikh

Tools, APIs and Frameworks

• Materialize as a front-end framework
• Knockout as a Javascript MVVC model based framework
• JSDoc to generate javascript code documentation
• Google Maps API
• Zomato API

How to Use

1. Download all the files in the same folder. Request Zomato API Key at https://developers.zomato.com/api/ and update it on main.js file.
2. Open index.html in a web browser.
3. Click a restaurant to view its details. Close place's infowindow to return to the full map view.
4. Use Cities drop-down list to filter places based on any city.
5. User model.js to add more places.

Source Files

1. main.js - Read documentation in /docs folder for more details.
2. model.js - Read documentation in /docs folder for more details.
3. index.html - html file for the project
4. style.css - contains additional styles

Javascript Documentation

/docs folder contains the documentation files created usign JSDoc. Open index file to view this javascript source code related documentation.

License

GNU General Public License v3