initial commit
Some checks failed
Build Images and Deploy / Update-PROD-Stack (push) Failing after 17s
Some checks failed
Build Images and Deploy / Update-PROD-Stack (push) Failing after 17s
This commit is contained in:
36
README.md
Normal file
36
README.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# What's The Point
|
||||
|
||||
A web app for tracking predictions and points in TV/movie challenges with friends.
|
||||
|
||||
## Features
|
||||
- Register/login with email and password
|
||||
- Create and join challenges for shows/movies
|
||||
- Make and approve predictions
|
||||
- Mobile-first, modern UI
|
||||
|
||||
## Tech Stack
|
||||
- Frontend: React (Vite)
|
||||
- Backend: Node.js (Express)
|
||||
- Database: PostgreSQL
|
||||
- Auth: JWT (email/password)
|
||||
- Dockerized, self-hosted
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
- Docker & Docker Compose
|
||||
|
||||
### Setup
|
||||
1. Copy `.env.example` to `.env` and fill in secrets.
|
||||
2. Build and start all services:
|
||||
```sh
|
||||
docker compose up --build
|
||||
```
|
||||
3. Access the frontend at http://localhost:5173
|
||||
4. API runs at http://localhost:4000
|
||||
|
||||
## Deployment
|
||||
- See `prod-compose.yml` for production deployment.
|
||||
|
||||
## License
|
||||
MIT
|
||||
Reference in New Issue
Block a user