Added .env.example

.env.example

@@ -0,0 +1,27 @@
+# DB
+DATABASE_HOST=localhost
+DATABASE_PORT=5432
+DATABASE_USER=postgres
+DATABASE_PASSWORD=adminer1234
+DATABASE_NAME=postgres
+
+# JWT
+JWT_SECRET=545e9a3d-051a-4b79-8b2c-eae3c34c8f3a
+JWT_TOKEN_AUDIENCE=localhost:3000
+JWT_TOKEN_ISSUER=localhost:3000
+JWT_ACCESS_TOKEN_TTL=3600
+JWT_REFRESH_TOKEN_TTL=86400
+
+# REDIS
+REDIS_HOST=localhost
+REDIS_PORT=6379
+
+# GOOGLE
+GOOGLE_CLIENT_ID=<YOUR_ID_HERE>
+GOOGLE_CLIENT_SECRET=<YOUR_SECRET_HERE>
+
+# 2FA
+TFA_APP_NAME=auth-playground
+
+# SESSION
+SESSION_SECRET=365c4ac7-d5c3-4acb-a4f5-c70c691e321d

README.md

@@ -12,19 +12,16 @@ This app showcases real-world Authentication and Authorization techniques with N
 8. Google authentication
 9. Sessions with Passport
 
-## Installation
+## Get started
+
+1. Make sure you have docker installed on your local machine.
+2. Duplicate the `.env.example` file and rename it to `.env`. Fill in the required variables.
 
 ```bash
 # Install dependencies
 $ npm install
-```
-
-## Setup databases
 
-Make sure you have docker installed on your local machine.
-
-```bash
-# setup postgres and redis with docker
+# setup postgres database with docker
 $ docker compose up
 ```