Add README with quick start and roadmap link
This commit is contained in:
37
README.md
Normal file
37
README.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# 🏄 Cabo Bachelor Party Voting App
|
||||
|
||||
Real-time group voting for the bachelor party — hotels, golf, nightlife, excursions, and full itineraries.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
cd voting_app
|
||||
npm install
|
||||
node server.js
|
||||
# → http://localhost:3001
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- **Real-time WebSocket voting** — all clients update instantly
|
||||
- **5 categories** — Hotels, Golf, Nightlife, Excursions, Full Itineraries
|
||||
- **Add suggestions** — anyone can propose new venues
|
||||
- **Admin approval** — pending options require approval before going live
|
||||
- **Responsive** — works on desktop and mobile
|
||||
|
||||
## Data
|
||||
|
||||
Votes are stored in `data/votes.json` (created on first run). Edit directly or use the admin panel.
|
||||
|
||||
## Deployment
|
||||
|
||||
Deployed on `ice:3001` via Node.js directly (not Docker). Routed through Traefik on `ubuntu` via `cabo-voting.yml`.
|
||||
|
||||
See [Gitea Issues](https://gitea.tophermayor.com/TopherMayor/cabo-voting-app/issues) for the UI/UX roadmap.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- Node.js + Express
|
||||
- WebSocket (ws)
|
||||
- Vanilla JS frontend (no framework)
|
||||
- No database — JSON file persistence
|
||||
Reference in New Issue
Block a user