anupam-b/navigateme

This bot give users a new way to interact with Google Maps through text-based conversational interfaces.

Motivation

The primary motivation of the developers of MapBot is to provide a playground to tech enthusiasts, both beginners and advanced to try algorithms, approaches and ideas while contributing to a real-life project.

⭐ Getting Started

Refer to the following articles on the basics of Git and Github and can also contact the Project Mentors, in case you are stuck:

• Watch this video to get started, if you have no clue about open source

• Forking a Repo

• Cloning a Repo

• How to create a Pull Request

• Getting started with Git and GitHub

What are some pre-requisites?

• MySQL
  • Install the community version of mySQL from the official mySQL documentation page.
  • Create root user credentials during installation.
  • Verify the installation, running the command mysql -uroot -p -hlocalhost should open the mySQL monitor. (Enter the root password when prompted)
• StanfordCoreNLP
  • StanfordCoreNLP has a dependency on Java 8. java -version should complete successfully with version 1.8 or higher.
  • Windows- Download as a .zip file from here.
  • Linux and MacOS- Follow the instructions to download the file from here.

💥 Contribution

• Take a look at the Existing Issues or create your own Issues!
• Wait for the Issue to be assigned to you after which you can start working on it.
• Fork the Repo and create a Branch for any Issue that you are working upon.
• Read the Code of Conduct
• Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
• Add Screenshots to help us know what this Script is all about.
• Take a look at Contribution guide for Detail : Contribution Guide

⭐ Set-up and Contribution:

1. Fork this repository. Click on the symbol at the top right corner. 2. Clone the forked repository.

git clone https://github.com/<your-github-username>/NavigateMe

3. Create the mapbot database in mySQL

mysql -uroot -p -hlocalhost

Enter root password when prompted create database mapbot Verify creation of the database

show databases

4. Unzip the StanfordCoreNLP package in the repository and keep the file paths stanford-corenlp-x.x.x.jar and stanford-corenlp-x.x.x-models.jar handy.

Run

git update-index --assume-unchanged ENV/.env

Fill the existing template in ENV/.env with the corresponding values following the KEY=VALUE format

5. Run

python app.py

6. Navigate to the project directory.

cd NavigateMe

7. Make changes in source code.

8. Stage your changes and commit

#Add changes to Index
git add .
#Commit to the local repo
git commit -m "<your_commit_message>"

9. Push your local commits to the remote repo.

git push

10. Create a PR !

11. Congratulations! Sit and relax, you've made your contribution to NavigateMe project.

📢 Open Source Program

This Project is a part of the Lets Grow More Summer of Code

⭐ Issues:

For major changes, you are welcomed to open an issue and discuss what you would like to contribute. Enhancements will be appreciated.

Hall of Fame

✨ Thanks goes to these wonderful people (emoji key):

❤️ Project Admin

anupam-b 💻

navigateme's Issues

Improve UI

add some more badges to the README file

Description

add some more badges to the top of readme.md file, since the badges will be colorful and more attractive at the top of README.md file than the text the users will like it and after linking the badges it will also help them to navigate to different sections/ webpages like PRs, issues, contributors, etc.

Describe the solution you'd like

I will add some badges at the top and also will add links related to them so that the README.md file will look more interactive and awesome.

• I will align them to the center
• I will add some more badges
• I will add links to the badges

Work under/as

• LGMSOC
• Contributor

Create code of conduct