Skip to content

Latest commit

 

History

History
53 lines (47 loc) · 1.59 KB

README.md

File metadata and controls

53 lines (47 loc) · 1.59 KB
Raw

Plan-IT

deploy to frontend deploy to backend

What is Plan-it?

Plan-it is a sustainable travel routing web-app built on Google Maps to help users consciously keep track of their carbon emissions savings when commuting.

What's the purpose?

To encourage green choices, we will implement gamification features like rewards and social sharing for selecting low-carbon routes. The app will also provide tools for tracking carbon footprint over time, optimized route planning based on sustainability, and a community forum for knowledge sharing around sustainable transportation.

Test account details (Google account)

Username: planituser27@gmail.com
Password: planit123

ENV Setup:

  1. Setup environment variables for both frontend and backend frontend/
VITE_API_ENDPOINT=XYZ
VITE_GMAPS_API_KEY=XYZ
VITE_GIFY_API_KEY=XYZ
VITE_AUTH0_DOMAIN=XYZ
VITE_AUTH0_CLIENTID=XYZ
VITE_API_KEY=XYZ

backend/

MONGO_URI="mongodb_connection_string"
API_KEY="XYZ"
  1. Run both applications frontend/

For local deployments;

npm install
npm run dev

backend/

pip3 install -r requirements.txt
flask run

For Cloud Deployments:

  • Fork the entire repository, ensure Github Actions is enabled on forked repositoriy: Add the following secrets into Github Actions Secrets.
AWS_ACCESS_KEY_ID=XYZ
AWS_SECRET_ACCESS_KEY=XYZ
EC2_HOST=XYZ
EC2_SSH_KEY=XYZ