Update README with detailed EventSpace project information

Expanded the README to include a comprehensive overview of the EventSpace platform. Added sections on features, setup instructions, technical stack, development guidelines, and privacy notice. This improves clarity for both guests and administrators.
This commit is contained in:
2025-02-27 14:46:17 +01:00
parent 54d8032798
commit b7d60d1f29

108
README.md
View File

@@ -1,3 +1,107 @@
# eventspace
# EventSpace 🎈
A private family celebration platform designed to create beautiful digital experiences for special moments, starting with Emma's 1st birthday animal-themed celebration! 🦁🐘🦒
## About
EventSpace is a loving digital platform crafted to make family celebrations more special and organized. While it debuts with Emma's first birthday party, it's built to be our family's go-to platform for future celebrations.
## Features
### For Guests 👨‍👩‍👧‍👦
- **Digital Invitations**
- Beautifully designed with animal theme animations
- All event details in one place
- Mobile-friendly design
- **Simple RSVP**
- Quick confirmation process
- Add number of attendees
- Special messages for the birthday girl
- **Gift Registry**
- Browse available gift ideas
- Mark items as "getting this one!"
- See what others are bringing
- Direct links to purchase items
### For Hosts 👨‍👩‍👦
- **Event Dashboard**
- Track RSVPs in real-time
- Manage guest list
- Overview of gift registry status
- Export guest information
- **Customization**
- Update event details
- Manage gift registry
- Send updates to guests
## Getting Started
### For Family Members & Guests
1. Use the invitation link you received
2. No account needed - everything works through secure invitation links
3. RSVP and browse the gift registry
4. Check back for updates and photos
### For Administrators
1. Clone the repository:
```bash
git clone https://gitea.pragmazest.com/cardosofelipe/eventspace.git
cd eventspace
```
2. Set up environment:
```bash
cp .env.template .env
# Edit .env with your settings
```
3. Start the platform:
```bash
make dev
```
## Technical Overview
Built with love using:
- **Frontend**: Next.js 14 with Tailwind CSS
- **Backend**: FastAPI with PostgreSQL
- **Infrastructure**: Docker for easy deployment
## Development
### Prerequisites
- Docker and Docker Compose
- Node.js 18+
- Python 3.12+
### Local Development
```bash
# Start development environment
make dev
# Access the applications:
Frontend: http://localhost:3000
Backend API: http://localhost:8000
API Docs: http://localhost:8000/docs
```
### Production Deployment
```bash
# Build and push images
make push-images VERSION=1.0.0
# On production server
docker compose -f docker-compose.deploy.yml up -d
```
## Contributing
This is a private family project, but we welcome suggestions and improvements from family members! Contact Felipe with any ideas.
## Privacy Notice
EventSpace is a private platform for our family celebrations. All data is stored securely and is only accessible to invited guests.
Event Management platform