Walk2Zero 🐾 🌳

A group project undertaken as part of the Code First Girls Nanodegree.

          __        __    _ _      ____    _____              
          \ \      / /_ _| | | __ |___ \  |__  /___ _ __ ___  
           \ \ /\ / / _` | | |/ /   __) |   / // _ \ '__/ _ \ 
            \ V  V / (_| | |   <   / __/   / /|  __/ | | (_) |
             \_/\_/ \__,_|_|_|\_\ |_____| /____\___|_|  \___/ 
                                                              
             C L I M A T E   C O N S C I O U S   S T E P S                  

🏗 About

Walk2Zero is a program that calculates how much carbon a user can potentially offset if they opt for walking or using public transport to get to their point of destination, and represent it as number of trees being planted.

User can register and log in to the service, check and track their impact.

The program interacts with Google Maps API and MySQL database.

👯 The Team‍️

• Lakshika Juneja
• Rajwinder Bhatoe
• Robyn Seymour-Jones
• Shuyan Liu
• Sravya Betina

Getting Started

1. Clone the repo
   

In the terminal go on the working directory where you want to clone the project
Use the git clone command and paste the clone URL then press enter :

$ git clone https://github.com/Walk2Zero/walk2zero.git

2. On your local machine go inside of the walk2zero directory :

$ cd walk2zero

Prerequisites

The requirements to run the project are :

certifi==2021.5.30
charset-normalizer==2.0.4
colorama==0.4.4
idna==3.2
mysql-connector-python==8.0.26
numpy==1.21.2
pandas==1.3.2
protobuf==3.17.3
pyfiglet==0.8.post1
python-dateutil==2.8.2
pytz==2021.1
requests==2.26.0
six==1.16.0
urllib3==1.26.6

To install these requirements, run in the terminal :

$ pip install -r requirements.txt

Config

1. Set up database

Go to db/create-db.sql and run the script in MySQL workbench to set up the database

2. config DB password

Go to config.py, replace "password" with your own database password :

PASSWORD = "Your DB Password"

3. config API key

In config.py, replace "Your API Key" with your Google Maps API key :

API_KEY = "Your API Key"

Refer to this guide on how to get you own Google Maps API key

Run the code

Make sure you are in the walk2zero directory and run the following command :

$ python main.py

Finally

To get started on the app :

• Enter email
• Register yourself
• Enter a journey
• Get user stats
• Log out

Thank you for using Walk2Zero, you are making the world a greener, better place! 🌱 🌳