Mohammad-Masoomi-Homayoun/neo-user-service

Neo User Service

The neo-user-service is a RESTful web service that provides user management functionality. It is built with Java using the Spring Boot framework.

Getting Started

• Prerequisites
  • Java 17
  • Maven

Installation

Clone the repository and build the project:

git clone https://github.com/Mohammad-Masoomi-Homayoun/neo-user-service.git
cd neo-user-service
mvn clean install

Usage

To start the application, run the following command from the project directory: docker-compose up --build Replace with the version number of the application. By default, the application will start on port 9082.

API Documentation The neo-user-service provides the following REST endpoints:

Todo

• add swagger docs (OpenApi Specification 3)
• add login endpoint
• add register endpoint
• add Mapstruct
• add Redis and cacheable
• add message bundle and handling locale
• add spring actuator

Contributing

it's important to follow these steps:

1. Create a new branch for your task. This allows you to work on your changes without affecting the main codebase.
2. Commit your changes to your branch. Make sure to write clear and descriptive commit messages that explain what changes you've made and why.
3. Push your changes to the remote repository.
4. Open a pull request from your branch to the development branch.

By following these steps, you can help ensure that your contributions are properly tracked and integrated into the project in a timely and efficient manner.