Skip to content

Commit e82cb9e

Browse files
author
Ivan Franchin
committed
Project upgrade
- Upgrade to Spring Boot 3.4.3; - Upgrade to SpringDoc OpenAPI 2.8.5; - Upgrade some NPM packages; - Update README.
1 parent a62d23a commit e82cb9e

File tree

4 files changed

+33
-33
lines changed

4 files changed

+33
-33
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ On [ivangfr.github.io](https://ivangfr.github.io), I have compiled my Proof-of-C
2323

2424
`Spring Boot` Web Java backend application that exposes a Rest API to create, retrieve and delete books. If a user has `ADMIN` role he/she can also retrieve information of other users or delete them.
2525

26-
The application secured endpoints can just be just accessed if a user has valid credentials (`username` and `password`) and has autorization roles for it.
26+
The application's secured endpoints can only be accessed if a user has valid credentials (`username` and `password`) and has authorization roles for it.
2727

28-
`book-api` stores its data in [`Postgres`](https://www.postgresql.org/) database.
28+
`book-api` stores its data in a [`Postgres`](https://www.postgresql.org/) database.
2929

3030
`book-api` has the following endpoints:
3131

@@ -47,15 +47,15 @@ On [ivangfr.github.io](https://ivangfr.github.io), I have compiled my Proof-of-C
4747

4848
`React` frontend application where a user with role `USER` can retrieve the information of a specific book or a list of books. On the other hand, a user with role `ADMIN` has access to all secured endpoints.
4949

50-
To login, a `user` or `admin` must provide valid `username` and `password` credentials. `book-ui` communicates with `book-api` to get `books` and `users` data.
50+
To log in, a `user` or `admin` must provide valid `username` and `password` credentials. `book-ui` communicates with `book-api` to get `books` and `users` data.
5151

5252
`book-ui` uses [`Semantic UI React`](https://react.semantic-ui.com/) as CSS-styled framework.
5353

5454
## Prerequisites
5555

5656
- [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
57-
- [`Java 21+`](https://www.oracle.com/java/technologies/downloads/#java21)
58-
- Some containerization tool [`Docker`](https://www.docker.com), [`Podman`](https://podman.io), etc.
57+
- [`Java 21`](https://www.oracle.com/java/technologies/downloads/#java21) or higher;
58+
- A containerization tool (e.g., [`Docker`](https://www.docker.com), [`Podman`](https://podman.io), etc.)
5959

6060
## Start Environment
6161

@@ -102,11 +102,11 @@ On [ivangfr.github.io](https://ivangfr.github.io), I have compiled my Proof-of-C
102102
103103
## Demo
104104
105-
- The gif below shows a `user` loging in:
105+
- The gif below shows a `user` logging in:
106106
107107
![user-login](documentation/user-login.gif)
108108
109-
- The gif below shows an `admin` loging in:
109+
- The gif below shows an `admin` logging in:
110110
111111
![admin-login](documentation/admin-login.gif)
112112
@@ -120,7 +120,7 @@ On [ivangfr.github.io](https://ivangfr.github.io), I have compiled my Proof-of-C
120120
121121
- In the `Basic authentication` form that will open, provide the `admin` credentials (`admin/admin`) or `user` ones (`user/user`). Then, click `Authorize` and, finally, click `Close` button;
122122
123-
- Make some call to the endpoints.
123+
- Make some calls to the endpoints.
124124
125125
- **Manual Endpoints Test using curl**
126126
@@ -235,7 +235,7 @@ On [ivangfr.github.io](https://ivangfr.github.io), I have compiled my Proof-of-C
235235
236236
- To stop `book-api` and `book-ui`, go to the terminals where they are running and press `Ctrl+C`;
237237
238-
- To stop and remove docker compose containers, network and volumes, go to a terminal and, inside the `springboot-react-basic-auth` root folder, run the command below:
238+
- To stop and remove Docker Compose containers, network, and volumes, go to a terminal and, inside the `springboot-react-basic-auth` root folder, run the command below:
239239
```
240240
docker compose down -v
241241
```

book-api/pom.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<parent>
66
<groupId>org.springframework.boot</groupId>
77
<artifactId>spring-boot-starter-parent</artifactId>
8-
<version>3.4.0</version>
8+
<version>3.4.3</version>
99
<relativePath/> <!-- lookup parent from repository -->
1010
</parent>
1111
<groupId>com.ivanfranchin</groupId>
@@ -28,7 +28,7 @@
2828
</scm>
2929
<properties>
3030
<java.version>21</java.version>
31-
<springdoc-openapi.version>2.7.0</springdoc-openapi.version>
31+
<springdoc-openapi.version>2.8.5</springdoc-openapi.version>
3232
</properties>
3333
<dependencies>
3434
<dependency>

book-ui/package-lock.json

+19-19
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

book-ui/package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"private": true,
55
"dependencies": {
66
"@testing-library/jest-dom": "^6.6.3",
7-
"@testing-library/react": "^16.1.0",
8-
"@testing-library/user-event": "^14.5.2",
7+
"@testing-library/react": "^16.2.0",
8+
"@testing-library/user-event": "^14.6.1",
99
"react": "^18.3.1",
1010
"react-dom": "^18.3.1",
1111
"react-scripts": "5.0.1",
1212
"web-vitals": "^4.2.4",
13-
"axios": "^1.7.9",
13+
"axios": "^1.8.2",
1414
"react-router-dom": "^7.0.2",
1515
"semantic-ui-react": "^2.1.5"
1616
},

0 commit comments

Comments
 (0)