updated README file (#1)

I updated README.md. Please approve it. Love u.

Co-authored-by: Madeleine <madeleine@Madeleines-MacBook-Air.local>
Reviewed-on: #1
Reviewed-by: dominic <me@domdit.com>
This commit is contained in:
madeleinema 2026-06-13 16:03:46 -04:00
parent 2db4593dc9
commit 04d947b288

View file

@ -1,13 +1,18 @@
# Summary
A local app for local people.
A community-driven "Things To Do Near Me" platform that combines features of interactive maps, events, and local social recommendations.
Discover and share local events, hidden gems, activities, and experiences on an interactive map.
# Detailed Design
User should be able to create an event, search for events (MVPs), and share events (future).
Two users groups: Users who create events, and users who search for events. Users can be in both groups.
Interactive map with pins for events, and a list view of events.
Users can filter events by radius, category, tag, date, and location, etc.
## Functionality
### User Creates an Event
- Fills out form
- form includes:
- Form includes:
- Event Address
- Event Name
- Event Description
@ -44,11 +49,21 @@
## User Flow
## Web Pages
1. An interactive map page with pins for events, and a list view of events.
2. An event creation page with a form for users to fill out.
3. An event detail page that shows more information about the event.
4. An event editing page that allows users to edit or cancel their events.
5. An introduction page that explains the app and its features.
## DB Structure
## API Endpoints
## Authentication
Unique link for each event that can be used for editing and cancelling.
Future step:
- User accounts with email and password, or social login (Google, Facebook, etc.)
# Dependencies
- Frontend: React, Leaflet for interactive maps, and a UI library like Material-UI or Tailwind CSS.
- Backend: Django for API development, SQLite for database management, and like AWS S3 for image storage.