Skip to content

estao1/CleanCompass

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CleanCompass CleanCompass is a sustainable travel planning tool that empowers users to create eco-friendly travel itineraries while minimizing their carbon footprint. With its sleek user interface, multi-leg travel options, and data-driven insights, CleanCompass enables conscious travelers to navigate the world responsibly.

🌟 Tagline Navigate the World, Sustainably.

🌍 Inspiration The inspiration for CleanCompass stemmed from the need to address the growing concern around carbon emissions and unsustainable travel practices. We wanted to create a tool that helps travelers make greener choices without sacrificing convenience, all while fostering awareness about eco-friendly travel options.

🚀 What it Does Multi-Leg Travel Planner: Plan trips with multiple stops, including starting and ending locations. Carbon Emissions Optimization: Compare routes based on carbon impact, travel time, and cost. AI-Generated Suggestions: Discover sustainable destinations and activities tailored to your preferences. Dynamic Route Visualization: Interactive maps powered by Google Maps API to visualize your travel routes. Customizable Itineraries: Add or remove stops and reorder destinations with ease. 🔧 How We Built It Frontend React: Built a dynamic and responsive user interface for seamless interaction. Bootstrap: Leveraged for consistent styling and responsive design. Google Maps API: Integrated to visualize routes and provide multi-leg travel options. Backend Flask: API framework for handling server-side logic and communication. Python: Powering the backend with data processing and logic implementation. Technologies Axios: Simplified API requests to interact with the Flask backend. Vite: Ensured a fast and optimized development environment for React. 💪 Challenges We Faced API Integration: Integrating Google Maps API with multiple travel modes and stopovers. Dynamic Route Optimization: Balancing user preferences for cost, time, and carbon emissions in route suggestions. Cross-Platform Responsiveness: Ensuring a seamless experience across desktop and mobile devices. 🏆 Accomplishments We're Proud Of Successfully integrated a multi-leg route builder with a dynamic map. Designed a visually appealing and user-friendly interface. Implemented AI-generated destination suggestions for sustainable travel. 📚 What We Learned Mastering API integration and handling real-time data visualization with Google Maps. Efficient state management in React for dynamic form inputs. Developing a cohesive workflow between frontend and backend. 🔮 What's Next for CleanCompass Expanded Travel Modes: Add support for train and ferry travel. Carbon Emission Analytics: Detailed insights and comparisons for routes. Social Sharing: Allow users to share their sustainable travel plans with others. User Accounts: Implement personalized accounts to save itineraries. 🛠️ Getting Started Prerequisites Make sure you have the following installed:

Node.js (v16 or higher) Python (v3.9 or higher) Google Maps API Key Installation Clone the repository:

bash Copy Edit git clone https://github.com/estao1/SustainableTravel.git cd SustainableTravel Install frontend dependencies:

bash Copy Edit cd frontend npm install Install backend dependencies:

bash Copy Edit cd ../backend pip install -r requirements.txt Add your Google Maps API Key:

In the frontend code, replace API_KEY with your actual key. Running the Project Start the backend server:

bash Copy Edit cd backend flask run Start the frontend:

bash Copy Edit cd frontend npm run dev Open the app in your browser at http://localhost:5173.

📸 Screenshots Example of the travel planner interface.

Interactive Google Maps visualization.

📄 License This project is licensed under the MIT License.

🤝 Contributing We welcome contributions! Please fork the repository and create a pull request with your changes.

📧 Contact If you have any questions, feel free to reach out:

Email: your-email@example.com GitHub Issues: Open an issue here. Let me know if you’d like to tweak anything! 😊

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •