PopJonanek API

Kvalitní API v nest.js pro hru PopJonanek!

Plánované endpointy

Cesta	Metoda	Popis	Jen pro přihlášené	Vyžaduje	Vrací při úspěchu
/auth/login	POST	Přihlášení	❌	Email, Heslo	Informace o uživateli, JWT Token
/auth/register	POST	Registrace	❌	Email, přezdívku, heslo	Informace o uživateli, JWT token (Pošle email pro ověření)
/auth/email-verify	POST	Ověření emailu	❌	Token
/auth/forgot-password	POST	Poslání emailu pro resetování hesla	❌	Email
/auth/password-reset	POST	Nastavení nového hesla po resetovani z emailu	❌	Token, nové heslo
/user/[ID]	GET	Informace o uživateli	❌	USER_ID	USER_ID, přezdívka, avatar, celkový počet kliků, aktuální počet kliků
/user	GET	Získání informací o přihlášeném uživateli	✔		USER_ID, přezdívka, avatar, celkový počet kliků, aktuální počet kliků
/user	PUT	Aktualizace uživatele	✔
/user/clicks	PUT	Aktualizace počtu kliknutí uživatele	✔	Aktuální celkový počet kliknutí
/user/sound	PUT	Nastavení zvuku (musí být zakoupený)	✔	SOUND_ID
/user/background	PUT	Nastavení pozadí (musí být zakoupený)	✔	BACKGROUND_ID
/user/inventory	GET	Vypíše všechny zakoupené předměty uživatele	✔
/clicks/total	GET	Celkový počet kliknutí	❌
/shop/items	GET	Vypíše všechny předměty v obchodu	❌
/shop/items/[ID]/purchase	POST	Zakoupení předmětů v obchodu	✔

Env proměnné

Proměnná	Povinné	Výchozí hodnota	Popis
API_PORT	false	3000
DB_HOST	false	127.0.0.1	IP adresa/hostname databázového serveru
DB_PORT	false	3306	Port databázového serveru
DB_USER	true		Uživatel pro připojení na databázi
DB_PASSWORD	true		Heslo pro připojení na databázi
DB_DATABASE	true		Název databáze na databázovém serveru
USERNAME_MIN_LENGTH	false	2	Minimální délka přezdívky
USERNAME_MAX_LENGTH	false	32	Maximální délka přezdívky
PASSWORD_MIN_LENGTH	false	8	Minimální délka hesla
PASSWORD_MAX_LENGTH	false	50	Maximální délka přezdívky
PASSWORD_REGEX	false	/^(?=.[a-z])(?=.[A-Z])(?=.\d)(?=.[@$!%?&])[A-Za-z\d@$!%?&]+$/	Regex požadavky na heslo
HASH_SALT_ROUNDS	false	10
SMTP_HOST	true		IP adresa/hostname SMTP serveru
SMTP_PORT	false	465	Port SMTP serveru
SMTP_TLS	false	true	Povolení/zakázání TLS pro připojení na SMTP
SMTP_USER	true		Uživatel pro připojení na SMTP server
SMTP_PASSWORD	true		Heslo pro připojení na SMTP server
MAIL_FROM	true		Adresa, ze které se budou posílat emaily
MAIL_TOKEN_LENGTH_BYTES	false	8	Délka tokenu v mailech v bytech
MAIL_TOKEN_VALIDITY	false	15	Délka platnosti tokenu z mailu v minutách
JWT_SECRET	true
JWT_EXPIRES_IN	false	7d
CLICKS_UPDATE_LIMIT	false	600	Maximální počet kliknutí za aktualizaci kliků
CACHE_TTL	false	60	Délka cachování (/clicks/total /clicks/leaderboard)

Spuštění API

• Instalace

$ npm install

• Nastavení ENV proměnných (Viz. výše)

• Samotné spuštění

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod