builde7b0b / builderapi

a user authentication and authorization system that integrates with your existing applications. Users can sign up, log in, and access protected resources based on their roles and permissions.

BuilderAPI

This is a mini-project to build a user authentication and authorization system using Spring Boot and PostgreSQL. The project is designed to demonstrate how to build a monolithic backend using Spring Boot and its modules in order to create a web API using a monolithic approach.

Table of Contents

• Project Overview
• Technologies Used
• Usage
• ERD Diagram
• MVC Diagram
• Relationships
• Project Approach
• User Stories
• Contributing
• Credits

Demo

Project Overview

This mini-project aims to build a user authentication and authorization system that integrates with existing applications. Users can sign up, log in, and access protected resources based on their roles and permissions. The PostgreSQL database will consist of three models: User, Role, and Permission. The application will be developed using Spring Boot and will be running on the Tomcat server.

Technologies Used

• Java
• Spring Bot
• PostgreSQL
• Maven

Usage

Once the application is running, you can use a tool like Postman to interact with the API. You can sign up for a new account, log in to an existing account, and access protected resources based on your user roles and permissions.

MVC Diagram

ERD Diagram

Relationships

• The User entity is connected to the UserRole entity with a one-to-many relationship
• The Role entity is connected to the UserRole entity with a one-to-many relationship
• The Role entity is connected to the RolePermission entity with a one-to-many relationship
• The Permission entity is connected to the RolePermission entity with a many-to-one relationship,

Project Approach

Development Methodology: Agile

As a solo developer, Agile is a great development methodology to use because it emphasizes flexibility, collaboration, and delivering working software in short iterations. For this mini-project, I'll be using Agile as my development methodology, which means that I'll be breaking down the work into small, manageable chunks and iterating on the software over time.

Technology Stack: Spring Boot and PostgreSQL

For this mini-project, I'll be using Spring Boot as my framework for building the API and PostgreSQL as my database. Spring Boot is a popular framework for building enterprise-level Java applications, and it provides a powerful set of tools and modules for building REST APIs. PostgreSQL is a powerful and reliable open-source relational database that's well-suited for enterprise applications.

Project Management Tool: Github Projects

Github Projects is a great tool for solo developers because it allows me to create and manage a Kanban board that tracks the progress of the project. This will help me stay organized, prioritize tasks, and collaborate effectively with myself.

Link to Kanban Board

Overall, my approach to this mini-project will be to use Agile as my development methodology, Spring Boot and PostgreSQL as my technology stack, and Github Projects as my project management tool. By breaking down the work into small, manageable chunks and iterating on the software over time, I can ensure that I'm building a high-quality, well-documented API that meets the needs of my users

User Stories

• As a user, I want to be able to create a new account, so that I can access protected resources
• As a user, I want to be able to log in to my account, so that I can access my personal Information and protected resources.
• As a user, I want to be able to update my account information, so that my profile is accurate and up-to-date.

Contributing

Contributions to this project are welcome. If you find a bug or have an idea for a new feature, feel free to open an issue or submit a pull request. Before contributing, please read the Contributing Guidelines.

Credits

This project was created by [Eugene]. Special thanks to [Suresh & Drubo] for their guidance and support.

builderapi's Issues

Craft User Stories

Define a UserController class to handle API endpoints for user-related functionality.

Refactor

Project Setup - Initial

• Create a new project using Spring Boot Initializr.
• Add necessary dependencies to the project.
• Set up the project structure according to the package layout.
• Configure the application.properties file for PostgreSQL connection.
• Set up Spring Profiles for different environments.

Configure PostgreSQL database connection

Write tests for UserRepository.

Error: Failed to Run Server for quick Test

Error: IllegalStateException: Ambiguous mapping, Cannot map 'userController' method

Caused by: java.lang.IllegalStateException: Ambiguous mapping. Cannot map 'userController' method

Write tests and implement the UserRole entity class.

Add JWT dependency to project

Write tests and implement methods in UserController for creating, reading, updating, and deleting users.

Review & Test

• Write tests for documentation.
• Remove unused code and dependencies.
• Adhere to KISS and DRY principles.
• Write tests for code quality.
• Document code and give credit.

TypeError: Class - UserService - line 98

Another Server Error when Trying to Run: "Failed"

Add Spring Security dependency to project

Project Setup - Last

• - Write tests for the database connection.
• - Configure security filters and providers.
• - Generate JWT tokens upon successful authentication.
• - Define API endpoints for CRUD operations on User entities.
• - Define additional API endpoints for other entities.

Syntax Error: User

Caused by: org.postgresql.util.PSQLException: ERROR: syntax error at or near "user"

API Endpoints

• x Define a UserController class to handle API endpoints for user-related functionality.
• Write tests and implement methods in UserController for creating, reading, updating, and deleting users.
• Define additional controllers for other entities.
• Write tests and implement additional API endpoints for CRUD operations on other entities.
• Add documentation for REST API endpoints and their functionality.

TypeError: Class - MyUserDetailsService

Implement User Model/ UserRepo

Error Github: OpenSSH Private Key accessible on GitHub

handle exceptions

Create Custom Request and Response classes.

TypeError: Class - UserService

Create UserRepository interface and implement it

Define User Model with Fields

Role and Permission Models - Section

Security and Auth

• Add Spring Security dependency to the project.

• Write tests for security configuration.

• Define a SecurityController class to handle authentication and authorization.

• Write tests and implement methods in SecurityController for logging in and out.

• Define a RolePermission entity class to represent the relationship between a Role and a Permission.

• Write tests and implement the RolePermission entity class.

• Write tests and implement methods in SecurityController for generating and validating JWT tokens.

• Add necessary configuration for CORS handling.

• Write tests and implement exception handling in SecurityController.

Define roles and permissions for User model.

Implement CRUD operations for User model.

User Model Section

Define a UserRole entity class to represent the relationship between a User and a Role.