- Teddy Yang (teddyyang8)
- Yasmina Mimassi (yasmatopia)
- Shirley Zhang (shirleyyzhang)
- Ray Fang (rayf5372)
- Sean Woo (seanwoo12)
Travel Advisors is a personalized travel planner designed to enhance your travel experience. Users can create profiles, specify their interests, and receive curated recommendations for places to visit based on their preferences. This app helps you plan your adventures with features like mapping locations, rating visited places, and scheduling activities on a calendar. This project was created as part of our CSC207 course, highlighting the usage of Clean Architecture in software design.
- Personalized Recommendations: Users create profiles and select interests to receive a tailored list of places, allowing them to save set schedules to their respective profiles.
- Interactive Mapping: Visualize recommended locations on a map and understand the distances between them.
- Place Ratings: Like or dislike visited places and add personalized ratings.
- Activity Scheduling: Create schedules on a calendar for planned activities.
- Dynamic Filters: Filter your list of places by removing disliked locations or those already saved.
To set up and run Travel Advisors locally, you must have Java and a JVM installed to compile and run the program. Installing an IDE such as IntelliJ IDEA is recommended to run the program.
When you’ve downloaded Travel Advisors,
- Add the API Key from Google Cloud to .env.
- Then run mainWithDB.
- Once launched, in the top right of the IDE, open edit configurations
- Add the .env file to the environmental variables.
- Now you are ready to use the program!
Sign up by creating a username and password. List up to five fundamental interests and a city of choice and receive a curated list of suggested locations. Before searching, you can filter the list to remove disliked and previously saved locations. Select a few suggestions that interest you, and click the associated button to open it in Google Maps. You can then place your activities in a calendar to create your ideal timetable. Once you have visited a location, you can leave a personalized note and rating for it. The selected locations will be saved to your profile for future reference.
We welcome contributions to improve Travel Advisors! To contribute:
- Fork the repository.
- Create a feature branch: git checkout -b feature/your-feature-name
- Commit your changes: git commit -m "Add your feature description here"
- Push to the branch: git push origin feature/your-feature-name
- Submit a pull request.
- Code changes must be correctly implemented to achieve their intended functionality, pass all preexisting tests, and directly solve a problem.
- The title must be clear and concise, and the code should contain inline comments to document the changes made to explain non-obvious logic or decisions.
- All necessary changes and files must be included.
- It must reference related issues or tasks and potentially additional documentation to explain functionality.
- Reviewing Contributions
- Ensure the code behaves as intended and passes existing tests.
- Make precise comments that are unambiguous and concise.
- Confirm all related files are included in the documentation.
- Confirm the merge request has proper instructions for testing and validation.
- Ensure the branch has been rebased with the latest changes from the main branch.
This project uses the CC0 1.0 Universal license.