Commit 9a24f4c

committed

docs: increase version

1 parent 11d5516 commit 9a24f4cCopy full SHA for 9a24f4c

File tree

2 files changed

+40

-38

lines changed

README.md
api
- pom.xml

2 files changed

+40

-38

lines changed

`‎README.md`

Lines changed: 38 additions & 36 deletions

Original file line number	Diff line number	Diff line change
`@@ -24,12 +24,12 @@`
`24`	`24`
`25`	`25`	`- [Features](#features)`
`26`	`26`	`- [Requirements](#requirements)`
	`27`	`+- [Docker](#docker-examples)`
	`28`	`+- [Local installation](#local-installation)`
`27`	`29`	`- [Entities](#entities)`
`28`		`-- [Installation](#installation)`
`29`	`30`	`- [Running a specific test](#tests)`
`30`	`31`	`- [Swagger](#swagger)`
`31`	`32`	`- [Database Migrations](#database-migrations)`
`32`		`-- [Docker](#docker-examples)`
`33`	`33`	`- [Environment variables](#environment-variables)`
`34`	`34`
`35`	`35`	`# Features`
`@@ -56,7 +56,40 @@ This project was started with [Spring Initializr](https://start.spring.io/#!type`
`56`	`56`
`57`	`57`	`>[🚨 draw.io file here](./assets/database/diagram.drawio)`
`58`	`58`
`59`		`-## Installation`
	`59`	`+## Docker examples`
	`60`	`+`
	`61`	+> 🚨 create `environment` file and add permission to execute scripts
	`62`	`+>`
	`63`	+> ```shell
	`64`	`+> cp .docker/.env.example .docker/.env && chmod -R +x .docker/scripts`
	`65`	+> ```
	`66`	`+`
	`67`	`+- docker-compose for development`
	`68`	`+ - starting containers`
	`69`	+ ```
	`70`	`+ .docker/scripts/develop up -d --build`
	`71`	+ ```
	`72`	`+`
	`73`	`+ - removing contaiers`
	`74`	+ ```
	`75`	`+ .docker/scripts/develop down`
	`76`	+ ```
	`77`	`+`
	`78`	`+ - show backend logs`
	`79`	+ ```
	`80`	`+ .docker/scripts/develop logs -f api`
	`81`	+ ```
	`82`	`+`
	`83`	`+- docker-compose for production`
	`84`	+ ```
	`85`	`+ .docker/scripts/production up -d --build`
	`86`	+ ```
	`87`	`+`
	`88`	+ ```
	`89`	`+ .docker/scripts/production down`
	`90`	+ ```
	`91`	`+`
	`92`	`+## Local Installation`
`60`	`93`	`> 🚨 check [requirements](#requirements) or if you are using docker check [docker development instructions](#docker-examples)`
`61`	`94`
`62`	`95`	`- clone the repository and access the directory.`
`@@ -126,38 +159,6 @@ Creating database migration files`
`126`	`159`
`127`	`160`	`---`
`128`	`161`
`129`		`-## Docker examples`
`130`		`-`
`131`		-> 🚨 create `environment` file and add permission to execute scripts
`132`		`->`
`133`		-> ```shell
`134`		`-> cp .docker/.env.example .docker/.env && chmod -R +x .docker/scripts`
`135`		-> ```
`136`		`-`
`137`		`-- docker-compose for development`
`138`		`- - starting containers`
`139`		- ```
`140`		`- .docker/scripts/develop up -d --build`
`141`		- ```
`142`		`-`
`143`		`- - removing contaiers`
`144`		- ```
`145`		`- .docker/scripts/develop down`
`146`		- ```
`147`		`-`
`148`		`- - show backend logs`
`149`		- ```
`150`		`- .docker/scripts/develop logs -f api`
`151`		- ```
`152`		`-`
`153`		`-- docker-compose for production`
`154`		- ```
`155`		`- .docker/scripts/production up -d --build`
`156`		- ```
`157`		`-`
`158`		- ```
`159`		`- .docker/scripts/production down`
`160`		- ```
`161`	`162`
`162`	`163`	`## Environment variables`
`163`	`164`
`@@ -172,6 +173,7 @@ Creating database migration files`
`172`	`173`	\| displays the generated sql in the logger \| `DB_SHOW_SQL` \| false \|
`173`	`174`	\| set maximum database connections \| `DB_MAX_CONNECTIONS` \| 5 \|
`174`	`175`	\| secret value in token generation \| `TOKEN_SECRET` \| secret \|
	`176`	+\| secret hash ids \| `HASHID_SECRET` \| secret \|
`175`	`177`	\| token expiration time in hours \| `TOKEN_EXPIRATION_IN_HOURS` \| 24 \|
`176`	`178`	\| refresh token expiry time in days \| `REFRESH_TOKEN_EXPIRATION_IN_DAYS` \| 7 \|
`177`	`179`	\| SMTP server address \| `SMTP_HOST` \| smtp.gmail.com \|
`@@ -189,7 +191,7 @@ Creating database migration files`
`189`	`191`	> ```shell
`190`	`192`	`> # to change the value of some environment variable at runtime`
`191`	`193`	`> # on execution, just pass it as a parameter. (like --SERVER_PORT=80).`
`192`		`-> $ java -jar api-4.1.2.jar --SERVER_PORT=80`
	`194`	`+> $ java -jar api-5.0.0.jar --SERVER_PORT=80`
`193`	`195`	> ```
`194`	`196`
`195`	`197`

`‎api/pom.xml`

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -4,12 +4,12 @@`
`4`	`4`	`<parent>`
`5`	`5`	`<groupId>org.springframework.boot</groupId>`
`6`	`6`	`<artifactId>spring-boot-starter-parent</artifactId>`
`7`		`- <version>2.7.3</version>`
	`7`	`+ <version>2.7.4</version>`
`8`	`8`	`<relativePath /> <!-- lookup parent from repository -->`
`9`	`9`	`</parent>`
`10`	`10`	`<groupId>com.github.throyer.common.spring-boot</groupId>`
`11`	`11`	`<artifactId>api</artifactId>`
`12`		`- <version>4.1.2</version>`
	`12`	`+ <version>5.0.0</version>`
`13`	`13`	`<name>CRUD API</name>`
`14`	`14`
`15`	`15`	`<description>Exemplo de api simples com Spring Boot</description>`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 9a24f4c

File tree

2 files changed

2 files changed

`‎README.md`

`‎api/pom.xml`

0 commit comments