springboot-react-basic-auth

The goal of this project is to implement an application called book-app to manage books. For it, we will implement a back-end Spring Boot application called book-api and a front-end React application called book-ui. Besides, we will use Basic Authentication to secure both applications.

Proof-of-Concepts & Articles

On ivangfr.github.io, I have compiled my Proof-of-Concepts (PoCs) and articles. You can easily search for the technology you are interested in by using the filter. Who knows, perhaps I have already implemented a PoC or written an article about what you are looking for.

Additional Readings

• [Medium] Implementing A Full Stack Web App Using Spring-Boot and React
• [Medium] Implementing Social Login in a Spring Boot and React App
• [Medium] Building a Web Chat with Social Login using Spring Boot: Introduction
• [Medium] Building a Single Spring Boot App with Keycloak or Okta as IdP: Introduction

Project Overview

Applications

• book-api

  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.

  The application's secured endpoints can only be accessed if a user has valid credentials (username and password) and has authorization roles for it.

  book-api stores its data in a Postgres database.

  book-api has the following endpoints:

  Endpoint	Secured	Roles
  POST /auth/authenticate -d {"username","password"}	No
  POST /auth/signup -d {"username","password","name","email"}	No
  GET /public/numberOfUsers	No
  GET /public/numberOfBooks	No
  GET /api/users/me	Yes	ADMIN, USER
  GET /api/users	Yes	ADMIN
  GET /api/users/{username}	Yes	ADMIN
  DELETE /api/users/{username}	Yes	ADMIN
  GET /api/books [?text]	Yes	ADMIN, USER
  POST /api/books -d {"isbn","title"}	Yes	ADMIN
  DELETE /api/books/{isbn}	Yes	ADMIN

• book-ui

  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.

  To log in, a user or admin must provide valid username and password credentials. book-ui communicates with to get and data.

Prerequisites

• npm
• Java 25 or higher;
• A containerization tool (e.g., Docker, Podman, etc.)
• Bash 4.0 or higher (macOS ships with Bash 3.2; install via brew install bash)

Start Environment

• In a terminal, make sure you are inside the springboot-react-basic-auth root folder;

• Run the following command to start docker compose containers:

  docker compose up -d
  

Running book-app using Maven & Npm

• book-api

  • Open a terminal and navigate to the springboot-react-basic-auth/book-api folder;

  • Run the following Maven command to start the application:

    ./mvnw clean spring-boot:run
    

• book-ui

  • Open another terminal and navigate to the springboot-react-basic-auth/book-ui folder;

  • Run the command below if you are running the application for the first time:

    npm install
    

  • Run the npm command below to start the application:

    npm start
    

Applications URLs

Application	URL	Credentials
book-api	http://localhost:8080/swagger-ui.html
book-ui	http://localhost:3000	admin/admin, user/user or signing up a new user

Note: the credentials shown in the table are the ones already pre-defined. You can signup new users.

Demo

• The gif below shows a user logging in:

• The gif below shows an admin logging in:

Testing book-api Endpoints

• Manual Endpoints Test using Swagger

  • Open a browser and access http://localhost:8080/swagger-ui.html. All endpoints with the lock sign are secured. In order to access them, you need a valid username and password credentials;

  • Click Authorize button (white/green one, almost at the top of the page, right side);

  • 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;

  • Make some calls to the endpoints.

• Manual Endpoints Test using curl

  • Open a terminal:

  • Call GET /public/numberOfBooks:

    curl -i localhost:8080/public/numberOfBooks
    

    It should return

    HTTP/1.1 200
    70
    

  • Call GET /api/books without credentials:

    curl -i localhost:8080/api/books
    

    As this endpoint requires authentication, it should return:

    HTTP/1.1 401
    { "timestamp": "...", "status": 401, "error": "Unauthorized", "message": "Unauthorized", "path": "/api/books" }
    

  • Call again GET /api/books but now with user credentials:

    curl -i -u user:user localhost:8080/api/books
    

    It should return:

    HTTP/1.1 200
    [
      {"isbn":"978-1-60309-445-0","title":"A Shining Beacon"},
      {"isbn":"978-1-891830-85-3","title":"American Elf (Book 2)"},
      ...
    ]
    

  • Call POST /api/books with user credentials:

    curl -i -u user:user -X POST localhost:8080/api/books \
    -H "Content-Type: application/json" -d '{"isbn": "9781617292545", "title": "Spring Boot in Action"}'
    

    As user doesn't have the role ADMIN, it should return:

    HTTP/1.1 403
    { "timestamp": "...", "status": 403, "error": "Forbidden", "message": "Forbidden", "path": "/api/books" }
    

Util Commands

• Postgres

  docker exec -it postgres psql -U postgres -d bookdb
  \dt
  

Shutdown

• To stop book-api and book-ui, go to the terminals where they are running and press Ctrl+C;

• 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:

  docker compose down -v
  

Running Tests

• book-api

  • Open a terminal and navigate to the springboot-react-basic-auth/book-api folder;

  • Run all tests:

    ./mvnw clean test
    

• book-ui

  • Open a terminal and navigate to the springboot-react-basic-auth/book-ui folder;

  • Run all tests:

    npm test
    

How to upgrade book-ui dependencies to latest version

• In a terminal, make sure you are in the springboot-react-basic-auth/book-ui folder;

• Run the following commands:

  npm upgrade
  npm i -g npm-check-updates
  ncu -u
  npm install
  

Code Formatting

• Spring Boot module (book-api): Code is formatted using Spotless with Google Java Format.

  To check or apply formatting, make sure you are inside the module folder and run the following command:

  • Check formatting:

    ./mvnw spotless:check
    

  • Auto-fix formatting:

    ./mvnw spotless:apply
    

• React module (book-ui): Code is formatted using [Prettier](https://p