diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..edb1f1b --- /dev/null +++ b/.env.example @@ -0,0 +1,29 @@ +# Root Environment Variables (used by Docker Compose) + +# PostgreSQL Configuration (used by Docker Compose) +POSTGRES_USER=sportbuddy +POSTGRES_PASSWORD=sportbuddy123 +POSTGRES_DB=sportbuddy + +# Database URL (used by Backend/Prisma) +DATABASE_URL="postgresql://sportbuddy:sportbuddy123@postgres:5432/sportbuddy?schema=public" + +# Better Auth Configuration +# Generate a random 32+ character secret for production: openssl rand -base64 32 +BETTER_AUTH_SECRET="change-this-to-a-random-secret-in-production-min-32-chars" + +# Backend URL (used for Better Auth callbacks) +BETTER_AUTH_URL="http://localhost:3001" + +# Frontend Configuration +# API URL for frontend to communicate with backend +NEXT_PUBLIC_API_URL="http://localhost:3001" + +# OAuth Providers (Optional - configure only if you want to enable OAuth) +# Google OAuth: https://console.cloud.google.com/apis/credentials +GOOGLE_CLIENT_ID="" +GOOGLE_CLIENT_SECRET="" + +# Apple OAuth: https://developer.apple.com/account/resources/identifiers/list/serviceId +APPLE_CLIENT_ID="" +APPLE_CLIENT_SECRET="" diff --git a/README.md b/README.md index 8e0c67d..57ce2f7 100644 --- a/README.md +++ b/README.md @@ -19,17 +19,21 @@ Moderná webová aplikácia pre športových nadšencov - hľadanie spoluhráčo - Git - Ideálne WSL2 (Docker Engine nech beží tiež na WSL2) -### Inštalácia (3 kroky) +### Inštalácia (4 kroky) ```bash # 1. Klonuj projekt -git clone https://github.com/your-username/sportbuddy.git +git clone https://git.kemt.fei.tuke.sk/kb159dr/SportBuddy cd sportbuddy -# 2. Spusti Docker Compose (automaticky stiahne dependencies a spustí všetky služby) +# 2. Skopíruj environment variables (DÔLEŽITÉ!) +cp .env.example .env +# Voliteľne: uprav .env pre vlastné nastavenia + +# 3. Spusti Docker Compose (automaticky stiahne dependencies a spustí všetky služby) docker-compose up -d -# 3. Otvor aplikáciu v prehliadači +# 4. Otvor aplikáciu v prehliadači # Frontend: http://localhost:3000 # Backend API: http://localhost:3001/api ``` @@ -40,7 +44,9 @@ Prvé spustenie trvá ~1-2 minúty (sťahovanie images + npm install). ## Pre vývojárov -### Pri prvom spustení? +### Pri prvom spustení: + +**⚠️ Pred spustením: Uisti sa, že máš `.env` súbor (pozri krok 2 v inštalácii vyššie)** 1. **Docker stiahne images:** - `postgres:alpine` (databáza) @@ -142,7 +148,12 @@ sportbuddy/ ### Konfigurácia (.env súbor) -Projekt používa jeden `.env` súbor v roote. **Pre produkčný build `.env` do Gitu! necommitovať** +Projekt používa jeden `.env` súbor v roote. **Nikdy necommituj `.env` do Gitu!** + +**Pre nových vývojárov:** +```bash +cp .env.example .env +``` ### Premenné v .env: @@ -269,7 +280,8 @@ docker build --target production -t sportbuddy-frontend . ### ❌ Necommituj: - `node_modules/` (automaticky ignorované) -- `.env` (vývojarská verzia áno, produkčná dať do secrets!) +- `.next/` (build artefakty) +- `.env` (obsahuje secrets - NIKDY necommituj!) - `.vscode/`, `.idea/` (IDE nastavenia) ### 🔄 Po každom git pull: @@ -291,6 +303,7 @@ docker-compose up -d --build # 3. Vyčisti všetko a začni odznova docker-compose down -v +cp .env.example .env # Obnov .env ak bol zmazaný docker-compose up -d --build # 4. Skontroluj logy