Skip to content

MLH-Fellowship/VehiCO

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

17 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🚌 VehiCO 🚌

Saving the environment one trip at a time 🌳

VehiCO (pronounced Vehicle) is a webapp that aims to help users be more environmentally-conscious and make informed decisions by comparing the CO2 emission of different transportation modes for their trip. We also encourage users to take actions and contribute to sustainability efforts by providing a convenient way for them to neutralize their emission by donating to plant trees.


⭐ How VehiCO Works

Usage

Input origin and destination addresses πŸ“

We support address autocomplete for your input!

image.png

View Map Route and Trip Report for different transportation modes πŸš΄β€

You can view the distance, travel duration, and CO2 emission (in ton) based on your trip's origin and destination. To put your trip's CO2 emission into perspective, we also provided a chart comparing your trip's emission with other contexts! Once you decide on the transportation mode of your choice, you can get more detailed directions and routing by selecting Get Directions.

Screenshot-2020-12-07-225623.jpg

Neutralize your trip's carbon emission with an offset donation 🌲

In addition to helping you make more informed decisions of your choice of transportation mode, we also provided a convenient way for you to offset your carbon emission by donating to climate change organizations to plant trees!

image.png

Try out the API:

With the server running (instructions below), navigate to https://vehico-server.herokuapp.com/api-docs/ to test out the Swagger docs for the API.

πŸš€ Technology Stack:

  • Frontend:
  • Backend:
  • Version Control:
  • Deployment:

πŸ‘‰ Getting Started

Installation:

  • Fork and clone the repo
$ git clone https://github.com/MLH-Fellowship/VehiCO.git
$ cd VehiCO

Build and run using Docker

Build the containers for both client and server:

$ docker-compose up --build

Run the containers for client and server:

$ docker-compose up -d

Run using npm:

Frontend:

  • Install dependencies
$ cd client
$ npm install
  • Run the server and react app
$ npm run dev

Backend:

  • Install dependencies
$ cd server
$ npm install
  • Run the server
$ npm start

Navigate to http://localhost:3000/ to test the application.

Pulling docker images from Github registry:

  • For client:
$ docker pull ghcr.io/susiejojo/vehico:client
  • For server:
$ docker pull ghcr.io/susiejojo/vehico_server:server

❀️ Contributing

If you have suggestions for how VehiCO could be improved, or want to report a bug, open an issue! Contributions of all kinds are welcomed!

For more, check out the Contributing Guide.

πŸ“„ License

MIT Β© 2020 MLH Fellowship

Made with ❀️ by Chau Vu and Dipanwita Guhathakurta during Sprint 5 of the MLH Fellowship Explorer Batch, Fall 2020.

About

Saving the environment one trip at a time 🌳

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published