Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shinjimc/spring_security_thymeleaf
The Spring_Security_Thymeleaf project utilizes Java, Spring Boot, and Thymeleaf for a hardware store's invoicing system. It allows employees to generate invoices and admins to manage product data efficiently. Key technologies include Spring Security for authentication and MySQL for database management, all deployable via Docker.
https://github.com/shinjimc/spring_security_thymeleaf
authentication authorization crud docker hardware-store invoice-management java mysql pdf-generation role-based-access-control spring-boot spring-boot-3 spring-security spring-security-jwt tailwindcss thymeleaf web-application
Last synced: about 1 month ago
JSON representation
The Spring_Security_Thymeleaf project utilizes Java, Spring Boot, and Thymeleaf for a hardware store's invoicing system. It allows employees to generate invoices and admins to manage product data efficiently. Key technologies include Spring Security for authentication and MySQL for database management, all deployable via Docker.
- Host: GitHub
- URL: https://github.com/shinjimc/spring_security_thymeleaf
- Owner: ShinjiMC
- Created: 2023-12-03T05:25:24.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-21T04:15:11.000Z (10 months ago)
- Last Synced: 2024-11-06T03:37:40.238Z (3 months ago)
- Topics: authentication, authorization, crud, docker, hardware-store, invoice-management, java, mysql, pdf-generation, role-based-access-control, spring-boot, spring-boot-3, spring-security, spring-security-jwt, tailwindcss, thymeleaf, web-application
- Language: HTML
- Homepage: https://spring-security-thymeleaf.onrender.com
- Size: 146 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Spring_Security_Thymeleaf
[](https://github.com/ShinjiMC/Spring_Security_Thymeleaf/actions/workflows/docker.yml)
By Braulio Maldonado Casilla & Sergio Daniel Mogollon Caceres
The project simulates the process of generating invoices for a hardware store. When users log in (or create an account), they are assigned different roles according to their position in the company. Standard employees can generate invoices by selecting products and their respective quantities, which culminates in the automatic creation of a PDF file ready for printing.
On the other hand, users with the ADMIN role have additional privileges. They have access to the complete management of product data, which includes Create, Read, Update, and Delete (CRUD) operations, allowing them to edit, add, and delete products from the hardware store's database.
This system offers a comprehensive solution that streamlines the generation of invoices for employees and facilitates the efficient management of products for administrators, thus optimizing the hardware store's daily operations.
## Accounts
For standard user access:
- Email: [email protected]
- Password: user
For administrative access:
- Email: [email protected]
- Password: admin
## Installation and Configuration
To run the project locally, you will need to have the following installed:
1. **Java Development Kit (JDK)** - Version 17.
2. **Maven** - Java project management tool.
The project makes use of the following tools and libraries:
- Spring Boot 3.2.0
- Thymeleaf
- Spring Boot Starter Data JPA
- Spring Boot Starter Security
- Spring Boot Starter Web
- iText 7 Core
- MySQL Connector/J
- Lombok
- Spring Boot Starter Validation (Hibernate)
## Database Configuration
In the `application.yml` file, you will find the database connection configuration. You can modify the following fields according to your credentials and specific database configuration:
```yaml
spring:
datasource:
url: jdbc:mysql://MYSQLHOST:MYSQLPORT/MYSQLDATABASE
username: MYSQLUSER
password: MYSQLPASSWORD
```
## Main Features
Detailed description of the main functionalities of the project, including how to access them and their utility.
## Technologies Used
### Thymeleaf
Thymeleaf is used in HTML files for data integration in views:
File: `login.html`
```html
Your email
Password
Log in
```
### Hibernate Validator
Hibernate Validator is used in entities to apply validation constraints:
File: `Customer.java`
```java
import jakarta.validation.constraints.Email;
import jakarta.validation.constraints.NotEmpty;
import jakarta.validation.constraints.Size;
@Entity
@Table(name = "customer")
public class Customer {
// ... other attributes
@Column(name = "email")
@NotEmpty(message = "The email cannot be empty")
@Email(message = "The email must be valid")
private String email;
// ... other attributes
}
```
### Spring Security
Spring Security is used to configure authentication and authorization:
The file is configured to define security rules. In this code snippet, authorization directives with HTTP are set up, allowing access to certain routes like `/`, `register`, `/profile`, among others. Additionally, the login form is specified at `/login`, the login request processing at the same URL, and the redirection to `/profile` after a successful login. Finally, the logout functionality is enabled at `/logout`, with redirection to the login page.
File: `SpringSecurityConfig.java`
```java
@Configuration
@EnableMethodSecurity
public class SpringSecurityConfig {
// ... other methods and configurations
@Bean
public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
// Authorization configuration with HTTP
http.csrf(AbstractHttpConfigurer::disable);
http.authorizeHttpRequests(httpRequest ->
// Configuration of specific routes and permissions
httpRequest.requestMatchers("/", "register", "/profile**", "/agregateProduct**",
"/newProduct**", "/editProduct**")
.permitAll()
.anyRequest().authenticated())
.formLogin(formLogin -> formLogin
.loginPage("/login")
.loginProcessingUrl("/login")
.defaultSuccessUrl("/profile")
.permitAll())
.logout(logout -> logout
.logoutUrl("/logout")
.logoutSuccessUrl("/login")
.permitAll());
return http.build();
}
// ... other attributes
}
```
### Spring Data JPA
Spring Data JPA is used to handle data persistence.
File: `Boleta.java`
```java
@Entity
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Boleta {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
@OneToMany(cascade = CascadeType.ALL)
@JoinColumn(name = "boleta_id")
private List detalles;
private Double precioTotal;
// ... other attributes
}
```
## Spring Boot Starter Web
Spring Boot Starter Web is a dependency that provides features for building web applications. Here's an example of how it's used:
File: `CustomerController.java`
```java
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;
@Controller
@RequestMapping("api/v1/customers")
@RequiredArgsConstructor
public class CustomerController {
private final CustomerService customerService;
@PostMapping("/register")
public String createCustomer(@ModelAttribute("customer") Customer customer) {
customerService.createCustomer(customer);
return "redirect:/profile";
}
}
```
## Lombok
Lombok is a library that reduces code verbosity by automatically generating methods like getters, setters, constructors, etc. Here's an example of how it's used:
File: `Customer.java`
```java
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
@Getter
@Setter
@AllArgsConstructor
@NoArgsConstructor
@Entity
@Table(name = "customer")
public class Customer {
@Id
@GeneratedValue
private Long customerId;
@Column(name = "first_name")
private String firstName;
@Column(name = "last_name")
private String lastName;
@Column(name = "email")
private String email;
@Transient
private String password;
@OneToOne(mappedBy = "customer", cascade = CascadeType.ALL, fetch = FetchType.LAZY)
private UserAccount userAccount;
}
```
## Project Structure
In the project structure, each directory contains files related to specific system functionalities, such as authentication (`auth`), invoice management (`boleta`), configuration (`config`), customers (`customer`), products (`product`), security (`security`), and HTML resource files for views in templates. Additionally, the main project configuration file is located in `application.yml` within the `resources` directory.
- `src/main/java/com/tecsup/ferreteria/`
- `auth/`
- `Authority.java`
- `Role.java`
- `RoleRepository.java`
- `RoleService.java`
- `RoleServiceImpl.java`
- `boleta/`
- `Boleta.java`
- `BoletaController.java`
- `BoletaRepository.java`
- `BoletaService.java`
- `BoletaServiceImpl.java`
- `ProductoDetalle.java`
- `config/`
- `SpringSecurityConfig.java`
- `customer/`
- `Customer.java`
- `CustomerController.java`
- `CustomerRepository.java`
- `CustomerService.java`
- `CustomerServiceImpl.java`
- `product/`
- `Product.java`
- `ProductController.java`
- `ProductDTO.java`
- `ProductRepository.java`
- `ProductService.java`
- `ProductServiceImpl.java`
- `security/`
- `AccountService.java`
- `UserAccount.java`
- `UserAccountController.java`
- `UserAccountDetails.java`
- `UserAccountPasswordEncoder.java`
- `UserAccountRepository.java`
- `UserAccountService.java`
- `SpringSecurityApplication.java` (main)
- `src/main/resources/`
- `templates/`
- `agregateProduct.html`
- `chooseProducts.html`
- `descargarBoleta.html`
- `editProduct.html`
- `login.html`
- `products.html`
- `profile.html`
- `register.html`
- `application.yml`
## Screenshots
### Login Menu
[](https://postimg.cc/f3Myc9yh)
### Register Menu
[](https://postimg.cc/3WzwL6N1)
### Initial USER Menu
[](https://postimg.cc/zHHGzwtT)
### Initial Menu Searching for Product
[](https://postimg.cc/zbcfY2jJ)
### Menu for Choosing Products to Buy
[](https://postimg.cc/GBz2qmTT)
### Menu to Confirm Sale and Generate Invoice
[](https://postimg.cc/3kXW0BKB)
### Resulting Invoice PDF
[](https://postimg.cc/gn6xmpQ1)
### Initial ADMIN Menu
[](https://postimg.cc/JDnhgCj6)
### Product Management Menu
[](https://postimg.cc/ThKwJGdh)
### Menu for Adding a New Product
[](https://postimg.cc/z3Qysvtn)
### Menu for Editing a Product
[](https://postimg.cc/TKMpPSX1)
## License
This project is licensed under the [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-nc-sa/4.0/).
