Backend Project

About the Project

The purpose of this project is to provide backend services. Users can sign up, log in as a registered user to obtain a token, and perform specific actions based on their roles. This project follows a microservices architecture, where each microservice is responsible for specific tasks. Additionally, the project has been containerized using Docker to facilitate easier deployment of the application.

The Architecture of Backend Project:

Features of microservices:

In this project, there are three microservices;

TokenService
UserService
DefectService Each microservice has methods to perform certain operations. Now, let's examine each microservice separately.

1. TokenService:
This microservice allows the user to register using the 'register' method and obtain a JWT token using the 'login' method for the registered user. This token is required to access other microservices because it contains information about the user's role. The user can register with one of three roles in this microservice: 'ADMIN', 'OPERATOR', or 'TEAM_LEADER'. Additionally, this microservice has a method called 'GetRole' which returns the role information in response to a request with a JWT token from other microservices. Spring Security is used in TokenService, and its logic is as follows:

2. UserService:
In this microservice, a user with the 'ADMIN' role can perform the following operations: adding, deleting, updating users, and listing registered users. Additionally, there is a terminal listing operation that does not require role authorization.

3. DefectService:
To use the operations in this microservice, one must have either the 'OPERATOR' or 'TEAM_LEADER' roles. There are separate operations for each role. A user with the 'OPERATOR' role can add or delete vehicles and add defects to a vehicle. A user with the 'TEAM_LEADER' role can list and sort registered vehicles and defects, and view the image of a specific defect.

How do the microservices communicate with each other?

Communication between microservices is facilitated through the RestTemplate method. In this project, when a request is made to other microservices using the token obtained from the TokenService, the token is sent back to the TokenService along with the request for role information, ensuring authentication and authorization.

Getting Started

Prerequisites

Ensure that JDK 17 is installed.
Ensure that PostgreSQL is installed on your computer.
Ensure that Maven is installed and being used.
Ensure that Docker Hub is installed on your computer.

Installation by using your local computer

To get started with the project, follow the steps below:

Clone the project repositories from GitHub by running the following command :
```
git clone https://github.com/oguzhanyildiz22/BackendProject.git 
```
Make sure you have Java JDK 17 or a newer version installed on your computer.
Ensure that PostgreSQL is installed on your computer. You can download it from PostgreSQL official website and follow the installation instructions for your operating system.
Verify that Maven is installed by running the following command in your terminal:
```
mvn -version
```
If Maven is not installed, you can download it from the Apache Maven website and follow the installation instructions.
Ensure that Docker Hub is installed on your computer. You can download and install Docker Desktop from the Docker website.
Once all the prerequisites are met, navigate to the project directory:
```
cd ProjectName
```
Build the project using the following command:
```
mvn clean install
```
Run the project:
```
mvn spring-boot:run
```
By following these steps, you should be able to successfully install and run the project on your local machine. Feel free to modify the instructions according to your project's specific requirements.

Installation by using Docker

To get started with the project in a Docker environment, follow the steps below:

Clone the project repositories from GitHub:

 git clone https://github.com/oguzhanyildiz22/BackendProject.git

Navigate to the project directory:
```
cd ProjectName
```
pull the images from Docker:
```
docker pull username/repository:tag
```
run the docker containers:
```
docker-compose up
```
By following these steps, you should be able to successfully run the project on your local machine by using Docker. Feel free to modify the instructions according to your project's specific requirements.

Usage

If you don't use Docker :

Clone the repositories
Open these repositories in your IDE
Run the project

If you use Docker:

Clone the repositories
pull the images from Docker:

docker pull username/repository:tag

Go to the directory where the docker-compose.yml file is located using command prompt
run the docker containers:

  docker-compose up

Contributing

We welcome contributions to improve Backend Project To contribute, please follow these steps:

Fork the repository and create your branch from master.
Clone the forked repository to your local machine.
Install the necessary dependencies.
Make your desired changes and ensure that the code passes any existing tests.
Commit your changes with descriptive commit messages.
Push your changes to your forked repository.
Open a pull request to the master branch of the original repository.
Provide a clear description of your changes and why they should be merged.
Be responsive to any feedback or questions during the review process.

Please note that we have a Code of Conduct in place to ensure a welcoming and inclusive community. By contributing to this project, you agree to abide by its terms.

If you have any questions or need further assistance, feel free to reach out to us through contact information.

License

The Backend Project project is licensed under the License.

For more information about the license, you can refer to the LICENSE file.

Contact

If you have any questions, suggestions, or feedback regarding the project, feel free to reach out to me. I welcome your contributions and are happy to assist you with any inquiries you may have. You can contact me through the following channels:

Email: oguzy2020@gmail.com
GitHub: oguzhanyildiz22
LinkedIn: Oğuzhan Yıldız

Don't hesitate to reach out to me. I look forward to hearing from you!

oguzhanyildiz22 / BackendProject