fix: envs

Author: Throyer

.docker/.env.example

@@ -1,8 +1,31 @@
 # docker
-COMPOSE_PROJECT_NAME=spring-boot-crud-containers
+COMPOSE_PROJECT_NAME=spring-boot-example-containers
 TIMEZONE=America/Sao_Paulo
+API_PORT=8080
+API_DEBUG_PORT=8000
+APP_PORT=3000
 
 # database
-DB_URL=database:5432/example_api
+DB_HOST=database
+DB_PORT=5432
+DB_NAME=example
 DB_USERNAME=root
-DB_PASSWORD=root
+DB_PASSWORD=root
+DB_SHOW_SQL=true
+DB_MAX_CONNECTIONS=5
+
+# security
+TOKEN_SECRET=secret
+TOKEN_EXPIRATION_IN_HOURS=24
+REFRESH_TOKEN_EXPIRATION_IN_DAYS=7
+MINUTES_TO_EXPIRE_RECOVERY_CODE=20
+MAX_REQUESTS_PER_MINUTE=20
+
+# smtp
+SMTP_HOST=smtp.gmail.com
+SMTP_PORT=587
+SMTP_USERNAME=user@gmail
+SMTP_PASSWORD=secret
+
+# swagger
+SWAGGER_URL=/docs

.docker/docker-compose.dev.yml

@@ -14,17 +14,17 @@ services:
         "log_destination=stderr"
       ]
     ports:
-      - "5432:5432"
+      - "${DB_PORT}:5432"
     environment:
       POSTGRES_USER: ${DB_USERNAME}
       POSTGRES_PASSWORD: ${DB_PASSWORD}
-      POSTGRES_DB: example_api
-      TZ: America/Sao_Paulo
-      PGTZ: America/Sao_Paulo
+      POSTGRES_DB: ${DB_NAME}
+      TZ: ${TIMEZONE}
+      PGTZ: ${TIMEZONE}
     volumes:
       - ./.volumes/database:/var/lib/postgresql/data
     networks:
-      - simple-network
+      - example-network
     tty: true
 
   api:
@@ -34,20 +34,46 @@ services:
     links:
       - database
     ports:
-      - "8080:8080"
-      - "8000:8000"
+      - "${API_PORT}:${API_PORT}"
+      - "${API_DEBUG_PORT}:${API_DEBUG_PORT}"
     environment:
-      DB_URL: ${DB_URL}
+
+      # database
+      DB_PORT: ${DB_PORT}
+      DB_NAME: ${DB_NAME}
+      DB_HOST: ${DB_HOST}
       DB_USERNAME: ${DB_USERNAME}
       DB_PASSWORD: ${DB_PASSWORD}
+      DB_SHOW_SQL: ${DB_SHOW_SQL}
+      DB_MAX_CONNECTIONS: ${DB_MAX_CONNECTIONS}
+
+      # security
+      TOKEN_SECRET: ${TOKEN_SECRET}
+      TOKEN_EXPIRATION_IN_HOURS: ${TOKEN_EXPIRATION_IN_HOURS}
+      REFRESH_TOKEN_EXPIRATION_IN_DAYS: ${REFRESH_TOKEN_EXPIRATION_IN_DAYS}
+      MINUTES_TO_EXPIRE_RECOVERY_CODE: ${MINUTES_TO_EXPIRE_RECOVERY_CODE}
+      MAX_REQUESTS_PER_MINUTE: ${MAX_REQUESTS_PER_MINUTE}
+
+      # smtp
+      SMTP_HOST: ${SMTP_HOST}
+      SMTP_PORT: ${SMTP_PORT}
+      SMTP_USERNAME: ${SMTP_USERNAME}
+      SMTP_PASSWORD: ${SMTP_PASSWORD}
+
+      # swagger
+      SWAGGER_URL: ${SWAGGER_URL}
     volumes:
       - ../api:/app
       - ./.volumes/maven:/root/.m2
     working_dir: /app
     networks:
-      - simple-network
+      - example-network
     tty: true
-    entrypoint: "mvn spring-boot:run"
+    entrypoint: [
+      'mvn',
+      'spring-boot:run',
+      '-Dspring-boot.run.jvmArguments="-agentlib:jdwp=transport=dt_socket,server=y,address=*:${API_DEBUG_PORT},suspend=n"'
+    ]
 
   web:
     build:
@@ -57,15 +83,15 @@ services:
     restart: unless-stopped
     container_name: crud-web
     ports:
-      - "3000:3000"
+      - "${APP_PORT}:${APP_PORT}"
     volumes:
       - ../web:/app
     working_dir: /app
     networks:
-      - simple-network
+      - example-network
     tty: true
     entrypoint: "npm run dev"
 
 networks:
-  simple-network:
+  example-network:
     driver: bridge

README.md

@@ -67,7 +67,10 @@ This project was started with [Spring Initializr](https://start.spring.io/#!type
   ```shell
   mvn -f api/pom.xml install -DskipTests
   ```
-- run the application
+- run the application 
+  - home http://localhost:8080
+  - api http://localhost:8080/api
+  - swagger http://localhost:8080/docs
   ```shell
   mvn -f api/pom.xml spring-boot:run
   ```
@@ -97,10 +100,10 @@ use the parameter `-Dtest=<class>#<method>`
 
 
 ## Swagger
-Once the application is up, it is available at: [localhost:8080/documentation](localhost:8080/documentation)
+Once the application is up, it is available at: [localhost:8080/docs](http://localhost:8080/docs)
+> 🚨 if you set `SWAGGER_USERNAME` and `SWAGGER_PASSWORD` on `.env` file this route require authentication
 
-
-[example on heroku](https://throyer-crud-api.herokuapp.com/documentation)
+[example on heroku](https://throyer-crud-api.herokuapp.com/docs)
 
 ---
 
@@ -164,9 +167,11 @@ Creating database migration files
 | **Description**                          | **Parameter**                      | **Default values**        |
 |------------------------------------------|------------------------------------|---------------------------|
 | server port                              | `SERVER_PORT`                      | 8080                      |
-| database url                             | `DB_URL`                           | localhost:5432/common_app |
-| username (database)                      | `DB_USERNAME`                      | root                      |
-| user password (database)                 | `DB_PASSWORD`                      | root                      |
+| database host                            | `DB_HOST`                          | localhost                 |
+| database port                            | `DB_PORT`                          | 5432                      |
+| database name                            | `DB_NAME`                          | example                   |
+| database username                        | `DB_USERNAME`                      | root                      |
+| database user password                   | `DB_PASSWORD`                      | root                      |
 | displays the generated sql in the logger | `DB_SHOW_SQL`                      | false                     |
 | set maximum database connections         | `DB_MAX_CONNECTIONS`               | 5                         |
 | secret value in token generation         | `TOKEN_SECRET`                     | secret                    |
@@ -177,7 +182,8 @@ Creating database migration files
 | SMTP username                            | `SMTP_USERNAME`                    | user                      |
 | SMTP server password                     | `SMTP_PASSWORD`                    | secret                    |
 | time for recovery email to expire        | `MINUTES_TO_EXPIRE_RECOVERY_CODE`  | 20                        |
-| max requests per minute                  | `MAX_REQUESTS_PER_MINUTE`          | 10                        |
+| max requests per minute                  | `MAX_REQUESTS_PER_MINUTE`          | 50                        |
+| swagger url                              | `SWAGGER_URL`                      | /docs                     |
 | swagger username                         | `SWAGGER_USERNAME`                 | `null`                    |
 | swagger password                         | `SWAGGER_PASSWORD`                 | `null`                    |
 

api/pom.xml

@@ -204,11 +204,6 @@
       <plugin>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-maven-plugin</artifactId>
-        <configuration>
-          <jvmArguments>
-            -agentlib:jdwp=transport=dt_socket,address=*:8000,server=y,suspend=n
-          </jvmArguments>
-        </configuration>
       </plugin>
       <plugin>
         <groupId>org.jacoco</groupId>

api/src/main/resources/application.properties

@@ -12,7 +12,7 @@ spring.jpa.show-sql=${DB_SHOW_SQL:true}
 
 # Banco de dados
 spring.datasource.hikari.maximum-pool-size=${DB_MAX_CONNECTIONS:5}
-spring.datasource.url=jdbc:postgresql://${DB_URL:localhost:5432/common_app}
+spring.datasource.url=jdbc:postgresql://${DB_HOST:localhost}:${DB_PORT:5432}/${DB_NAME:example}
 spring.datasource.username=${DB_USERNAME:root}
 spring.datasource.password=${DB_PASSWORD:root}
 spring.jpa.hibernate.ddl-auto=none
@@ -23,6 +23,9 @@ spring.h2.console.enabled=false
 spring.jpa.open-in-view=false
 
 # swagger
+springdoc.swagger-ui.path=${SWAGGER_URL:/docs}
+swagger.username=${SWAGGER_USERNAME:#{null}}
+swagger.password=${SWAGGER_PASSWORD:#{null}}
 springdoc.default-produces-media-type=application/json
 springdoc.default-consumes-media-type=application/json
 
@@ -32,13 +35,11 @@ token.refresh.expiration-in-days=${REFRESH_TOKEN_EXPIRATION_IN_DAYS:7}
 token.secret=${TOKEN_SECRET:secret}
 server.servlet.session.cookie.name=API_EXAMPLE_SESSION_ID
 server.servlet.session.cookie.path=/app
-swagger.username=${SWAGGER_USERNAME:#{null}}
-swagger.password=${SWAGGER_PASSWORD:#{null}}
 
 # smtp configurations
 spring.mail.host=${SMTP_HOST:smtp.gmail.com}
 spring.mail.port=${SMTP_PORT:587}
-spring.mail.username=${SMTP_USERNAME:user}
+spring.mail.username=${SMTP_USERNAME:user@gmail}
 spring.mail.password=${SMTP_PASSWORD:secret}
 
 spring.mail.properties.mail.smtp.auth=true
@@ -75,7 +76,7 @@ bucket4j.filters[0].metrics.tags[0].expression=getRemoteAddr()
 bucket4j.filters[0].strategy=first
 bucket4j.filters[0].rate-limits[0].skip-condition=getRequestURI().contains('/swagger-ui') || getRequestURI().contains('/documentation')
 bucket4j.filters[0].rate-limits[0].expression=getRemoteAddr()
-bucket4j.filters[0].rate-limits[0].bandwidths[0].capacity=${MAX_REQUESTS_PER_MINUTE:10}
+bucket4j.filters[0].rate-limits[0].bandwidths[0].capacity=${MAX_REQUESTS_PER_MINUTE:50}
 bucket4j.filters[0].rate-limits[0].bandwidths[0].time=1
 bucket4j.filters[0].rate-limits[0].bandwidths[0].unit=minutes
 bucket4j.filters[0].rate-limits[0].bandwidths[0].fixed-refill-interval=0