Update README with accurate features and tech stack
This commit is contained in:
43
README.md
43
README.md
@@ -1,20 +1,31 @@
|
|||||||
# RSVP Manager
|
# RSVP Manager
|
||||||
|
|
||||||
A modern event RSVP management system with a dark theme interface.
|
A modern event RSVP management system with customizable backgrounds and item coordination.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- User-friendly RSVP interface
|
- User-friendly RSVP interface
|
||||||
- Event management
|
- Comprehensive event management
|
||||||
- Guest tracking
|
- Create and manage events
|
||||||
- Dark theme UI
|
- Track RSVPs and guest counts
|
||||||
|
- Coordinate needed items and track who's bringing what
|
||||||
|
- Customizable event backgrounds/wallpapers
|
||||||
|
- Real-time item status tracking
|
||||||
|
- See what items are still needed
|
||||||
|
- Track claimed items
|
||||||
|
- Prevent duplicate item claims
|
||||||
|
- Guest management
|
||||||
|
- Track guest attendance
|
||||||
|
- Support for bringing additional guests
|
||||||
|
- Guest names tracking
|
||||||
|
- Modern, responsive UI
|
||||||
- Containerized deployment
|
- Containerized deployment
|
||||||
|
|
||||||
## Tech Stack
|
## Tech Stack
|
||||||
|
|
||||||
- Frontend: React with TypeScript
|
- Frontend: React with TypeScript and Material-UI
|
||||||
- Backend: Node.js/Express with TypeScript
|
- Backend: Node.js/Express with TypeScript
|
||||||
- Database: MySQL
|
- Database: SQLite
|
||||||
- Containerization: Docker
|
- Containerization: Docker
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
@@ -57,6 +68,26 @@ A modern event RSVP management system with a dark theme interface.
|
|||||||
npm start
|
npm start
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Key Features Explained
|
||||||
|
|
||||||
|
#### Event Creation and Management
|
||||||
|
- Create events with title, description, date, time, and location
|
||||||
|
- Upload custom wallpapers to personalize event pages
|
||||||
|
- Manage RSVPs and track attendance
|
||||||
|
|
||||||
|
#### Item Coordination
|
||||||
|
- Create a list of needed items for the event
|
||||||
|
- Attendees can claim items they'll bring
|
||||||
|
- Real-time tracking of claimed vs needed items
|
||||||
|
- Prevent duplicate item claims
|
||||||
|
- Remove items that are no longer needed
|
||||||
|
|
||||||
|
#### RSVP Management
|
||||||
|
- Track who's attending
|
||||||
|
- Support for bringing additional guests
|
||||||
|
- Keep track of guest names
|
||||||
|
- Manage what items each person is bringing
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
MIT
|
MIT
|
||||||
Reference in New Issue
Block a user