New homepage
This commit is contained in:
81
README.md
81
README.md
@@ -1,24 +1,79 @@
|
||||
# README
|
||||
# Aperonight - Party Booking Platform
|
||||
|
||||
This README would normally document whatever steps are necessary to get the
|
||||
application up and running.
|
||||

|
||||
|
||||
Things you may want to cover:
|
||||
## 🌃 Overview
|
||||
|
||||
* Ruby version
|
||||
**Aperonight** is a two-sided marketplace connecting party-goers with nightlife promoters in Paris. The platform allows:
|
||||
|
||||
* System dependencies
|
||||
- **Customers** to discover/book tickets for upcoming parties
|
||||
- **Promoters** to create/manage events and validate tickets at venue entrances
|
||||
|
||||
* Configuration
|
||||
## 🎯 Key Features
|
||||
|
||||
* Database creation
|
||||
### For Party-Goers
|
||||
✔ Browse upcoming parties with filters (date, location, music genre)
|
||||
✔ Book tickets with multiple bundle options (VIP, group passes, etc.)
|
||||
✔ Secure payment processing (credit cards, Apple/Google Pay)
|
||||
✔ Mobile-friendly e-tickets with QR codes
|
||||
|
||||
* Database initialization
|
||||
### For Promoters
|
||||
✔ Event creation dashboard with ticket type customization
|
||||
✔ Real-time ticket validation via mobile scanning
|
||||
✔ Sales analytics and attendee tracking
|
||||
✔ Automatic aggregation of events from partner platforms
|
||||
|
||||
* How to run the test suite
|
||||
## 🛠 Technical Stack
|
||||
|
||||
* Services (job queues, cache servers, search engines, etc.)
|
||||
### Backend
|
||||
- **Ruby on Rails 7** (API mode)
|
||||
- **MariaDB** database
|
||||
<!--- **Redis** for caching/background jobs-->
|
||||
- **ActiveJob** for background processing
|
||||
|
||||
* Deployment instructions
|
||||
### Frontend
|
||||
- **Hotwire (Turbo + Stimulus)** for reactive UI
|
||||
- **Tailwind CSS** for styling
|
||||
- **React Native** for promoter mobile app (ticket scanning)
|
||||
|
||||
* ...
|
||||
### Key Integrations
|
||||
- **Stripe Connect** for payments & promoter payouts
|
||||
- **Shogun/Bizouk/Weezevent APIs** for event aggregation
|
||||
<!--- **Twilio** for SMS ticket delivery-->
|
||||
<!--- **AWS S3** for media storage-->
|
||||
|
||||
## 📊 Database Schema (Simplified)
|
||||
|
||||
```mermaid
|
||||
erDiagram
|
||||
USER ||--o{ BOOKING : makes
|
||||
USER {
|
||||
integer id
|
||||
string email
|
||||
string encrypted_password
|
||||
}
|
||||
PROMOTER ||--o{ PARTY : creates
|
||||
PROMOTER {
|
||||
integer id
|
||||
string stripe_account_id
|
||||
}
|
||||
PARTY ||--o{ TICKET_TYPE : has
|
||||
PARTY {
|
||||
integer id
|
||||
datetime start_time
|
||||
}
|
||||
BOOKING ||--o{ TICKET : generates
|
||||
BOOKING {
|
||||
integer id
|
||||
decimal total_price
|
||||
}
|
||||
TICKET_TYPE ||--o{ TICKET : defines
|
||||
TICKET_TYPE {
|
||||
integer id
|
||||
string name
|
||||
}
|
||||
TICKET {
|
||||
integer id
|
||||
string qr_code
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user