This project is an implementation of a RESTful API for managing insurance policies.
- Features
- Technologies Used
- Getting Started
- API Documentation
- Contributing
- License
The API supports the following features:
- Creating and managing clients
- updating deleteing and retriving a particular clients by id
- Retrieving a list of all clients
- Creating and managing insurance policies for clients
- updating deleteing and retriving a particular insurance policies by id
- Retrieving a list of all insurance policies
- Creating and managing claim for insurance policies
- updating deleteing and retriving a particular claim by id
- Retrieving a list of all claim
- Retrieving a list of all claim for a client
- Authenticating users and generating JWT tokens for authorization
- Documentation all api using swaagger-ui
The project is built using the following technologies:
- Java 17
- Spring Boot 3.0.5
- Spring Security
- JWT for authentication
- Hibernate for ORM mapping
- MySQL for the database
- Swagger for API documentation
To get started with the project, you will need to have the following tools installed on your machine:
- JDK 11 or later
- Maven
- MySQL
To set up the project, follow these steps:
- Clone the project repository: git clone https://github.com/VINAYKUMARKUNDER/Insurance-Management-System.git
- Navigate to the project directory: cd insurance-policy-management
- Open the application.properties file and configure your MySQL database settings
- Build the project using Maven: mvn clean install
- Run the project: mvn spring-boot:run
The API will be accessible at http://localhost:8080.
API documentation is available using Swagger. To access the documentation, run the project and navigate to http://localhost:8080/swagger-ui.html.
If you would like to contribute to the project, please follow these steps:
- Fork the project repository
- Create a new branch for your changes: git checkout -b my-new-feature
- Make your changes and commit them: git commit -am 'Add some feature'
- Push the changes to your branch: git push origin my-new-feature
- Submit a pull request
This project is licensed under the MIT License. See the LICENSE file for details.