Serencity is a web application designed to help users discover and share serene spots in their locality. Leveraging Google Maps and OAuth integration, Serencity provides an interactive platform for exploring and marking out peaceful locations.
- Spot Discovery: Users can explore a variety of serene spots marked on the map.
- User Authentication: Secure login/logout functionality with Google OAuth.
- Spot Management: Users can add, save, view, and delete their favorite spots.
- Google Maps Integration: Interactive map to view and select serene spots.
- Event Invitations: Users can send invites for events at their favorite spots via Google Calendar.
- Responsive Design: The application is designed to be responsive and user-friendly.
To set up Serenity on your local machine, follow these steps:
-
Clone the repository:
git clone https://github.com/yale-cpsc-419-fa23/project-project-group-5.git
-
Install the required dependencies:
pip install -r requirements.txt
- Set up environment variables:
- Create a
.env
file in the root directory. - Add the necessary configurations (e.g.,
GOOGLE_CLIENT_ID
,GOOGLE_CLIENT_SECRET
,SECRET_KEY
).
- Run the application:
python app.py
Using .env
File: Place the following in your .env
file (this should be a file at the root of your project, not within any folder):
FLASK_APP=app.py
SECRET_KEY=mysecretkey
DATABASE_URI=sqlite:///instance/serencity.db
GOOGLE_MAPS_API_KEY=your_maps_api_key
GOOGLE_CLIENT_ID=your_client_id_here
GOOGLE_CLIENT_SECRET=your_client_secret_here
- [Steps to get Keys] (https://docs.google.com/document/d/1kUtxLRn5iqxcP2-q2KLt6ZnEpUdv9dgzD7TWDzSeJZc/edit)
Developed over 3 months in CPSC 419 Fall 2023 class.
- [aileen.siele@yale.edu] (Aileen Siele)
- [basvi.vimbisai@gmail.com] (Vimbisai Basvi)
- [sarah.teng@yale.edu] (Sarah Teng)