Adjusted readme

Author: andersonresende

README.md

@@ -123,8 +123,9 @@ Copy the `.env.example` files to `.env` and update the variables with your own v
    python3 -c "import secrets; print(secrets.token_hex(32))"
    ```
 2. The DATABASE, MAIL, OPENAPI, CORS, and FRONTEND_URL settings are ready to use locally.
-3. The OPENAPI_URL setting is commented out. Uncommenting it will hide the /docs and openapi.json URLs, which is ideal for production.
-4. You can check the .env.example file for more information about the variables.
+3. If you're using Docker, the DATABASE and MAIL settings are already configured in Docker Compose.
+4. The OPENAPI_URL setting is commented out. Uncommenting it will hide the /docs and openapi.json URLs, which is ideal for production.
+5. You can check the .env.example file for more information about the variables.
 
 **Frontend (`nextjs-frontend/.env.local`):**
 Copy the `.env.example` files to `.env`. These values are unlikely to change, so you can leave them as they are.

docker-compose.yml

@@ -6,6 +6,7 @@ services:
       - OPENAPI_OUTPUT_FILE=./shared-data/openapi.json
       - DATABASE_URL=postgresql+asyncpg://postgres:password@db:5432/mydatabase
       - TEST_DATABASE_URL=postgresql+asyncpg://postgres:password@db:5433/testdatabase
+      - MAIL_SERVER=mailhog
     ports:
       - "8000:8000"
     networks:

fastapi_backend/.env.example

@@ -1,7 +1,7 @@
-# Local database (replace localhost with db if you are running the project with docker)
+# Local database
 DATABASE_URL=postgresql+asyncpg://postgres:password@localhost:5432/mydatabase
 
-# Test database(replace localhost with db_test if you are running the project with docker)
+# Test database
 TEST_DATABASE_URL=postgresql+asyncpg://postgres:password@localhost:5433/testdatabase
 
 # Secret keys
@@ -12,7 +12,7 @@ VERIFICATION_SECRET_KEY=your_verification_secret_key
 # OpenAPI genrated file output path
 OPENAPI_OUTPUT_FILE=../nextjs-frontend/openapi.json
 
-# Localhost Email configuration (replace localhost with mailhog if you are running the project with docker)
+# Localhost Email configuration
 MAIL_USERNAME=test
 MAIL_PASSWORD=test
 MAIL_FROM=[email protected]