/Book-Store_backend

Server-side application for my bookstore project made with Java Spring Boot

Primary LanguageJavaMIT LicenseMIT

Book-Store_backend

Utilizing Java Spring Boot, the back-end of the Bookstore project offers a comprehensive RESTful API, serving as the foundation for managing book-related interactions, including inventory, user transactions, and essential bookstore functionalities. The front-end side of this project is available here.

The deployed back-end side of the application can be found here.

Fully deployed app with client- and server-sides: https://bookstore-axos.netlify.app/

Table of Contents

Usage Guide

  1. Clone the project
    git clone https://github.com/alexonthespot7/Book-Store_backend.git
  2. Set the environmental variables (optional)
    1. To activate smtp service functionality you will need to set the following env variables with some real data.
      For that run the following commands in the command line (or change them in the application.properties file):
      $Env:SPRING_MAIL_HOST="your_smtp_host"
      $Env:SPRING_MAIL_USERNAME="your_smtp_username"
      $Env:SPRING_MAIL_PASSWORD="your_smtp_password"
      * You can use app without smtp service with some restrictions: The reset password functionality will be unavailable
    2. The default verification link sent to the user's email address uses the default React web address (http://localhost:3000). If you want to change it, you need to set the following env variable:
      $Env:FRONT_END_URL="your_front_end_url"
  3. Run the following command in a terminal window (in the complete) directory:
    ./mvnw spring-boot:run
  4. Navigate to localhost:8080

Features

  • Restful Endpoints: Provides RESTful API endpoints for seamless communication with the front-end application.

  • Authentication with JWT: Implements JSON Web Token (JWT) for secure authentication between the server-side and client-side applications.

  • All Users features:

    • Book Interactions: Browse books (all, by category, or by ID), add to cart, and place orders.
    • Account Operations: Login, signup, verification, and password reset functionalities.
    • Searching for Orders: by order id and randomly generated password.

  • Authenticated Users features:

    • Personalization: Access personal user information and view order history.

  • Admin features:

    • Management Features: Monitor and manage orders, users, books, and categories for efficient bookstore administration.

Technologies Used

  • Java Spring Boot
  • RESTful APIs
  • JWT (JSON Web Token)
  • smtp

Dependencies

  • spring-boot-starter-web: Starter for building web applications using Spring MVC.
  • spring-boot-devtools: Provides development-time tools to enhance developer productivity. Automatically triggers application restarts, among other features.
  • commons-lang3: Apache Commons Lang for utility functions.
  • spring-boot-starter-data-jpa: Starter for using Spring Data JPA for database access.
  • h2: H2 Database Engine, an in-memory relational database for development and testing purposes.
  • spring-boot-starter-data-rest: Starter for exposing Spring Data repositories over REST.
  • spring-boot-starter-security: Starter for enabling Spring Security and authentication/authorization features.
  • spring-boot-starter-mail: Starter for sending emails using Spring's JavaMailSender.
  • jjwt-api: JSON Web Token (JWT) API provided by JJWT library.
  • jjwt-impl: Implementation of the JSON Web Token (JWT) provided by JJWT library (runtime dependency).
  • jjwt-jackson: Jackson integration for JSON Web Token (JWT) provided by JJWT library (runtime dependency).
  • spring-boot-starter-test: Starter for testing Spring Boot applications.
  • spring-security-test: Spring Security testing support for integration testing.
  • rest-assured: Rest-assured for testing RESTful APIs.
  • junit-jupiter-api: JUnit 5 API for writing tests.
  • junit-jupiter-engine: JUnit 5 test engine implementation.
  • spring-boot-starter-validation: Starter for using validation in Spring Boot applications.
  • springdoc-openapi-starter-webmvc-ui: Starter for adding OpenAPI 3 documentation and Swagger UI support to your Spring Boot application.

Documentation

The documentation for this project is made with Swagger and can be accessed after launching the project at the following endpoints:

  1. http://localhost:8080/swagger-ui.html: if you're running the app on your pc.
  2. https://book-store-fc07569e741d.herokuapp.com/swagger-ui.html: deployed app.

Testing

Usage Guide

  1. Clone the project
    git clone https://github.com/alexonthespot7/Book-Store_backend.git
  2. Run the following command in a terminal window (in the complete) directory:
    ./mvnw test

Info

  1. Controllers testing.
  2. Repositories testing: CRUD functionalities + custom queries.
  3. Rest endpoints methods testing.

License

This project is under the MIT License.