Spring Project Template 🌱

Overview

The Spring Project Template is a kickstart project designed to accelerate the development of your applications using Spring Boot version 3.2.0 and Java 17. This template includes user registration and authentication, implementing JWT tokens and Spring Security, providing a secure foundation for your application.

Features 🚀

• Spring Boot 3.2.0: Utilizes the latest version of Spring Boot for enhanced features and performance.

• Java 17: Developed using Java 17 to leverage the latest language capabilities and improvements.

• User Registration and Login: Integrated user registration and login functionalities to jumpstart user management.

• JWT Tokens: Implements JSON Web Tokens (JWT) for secure authentication and authorization.

• Spring Security: Ensures robust security measures to protect your application.

• Swagger Documentation: This project comes with a Swagger UI to document your API endpoints. Access the Swagger UI here after you run the application.

Getting Started 🛠️

Follow these steps to get the project up and running on your local machine.

Prerequisites

• Java 17: Ensure you have Java 17 installed on your system.

• Maven: Make sure Maven is installed to manage project dependencies.

• MySQL: Install MySQL to set up the database.

• Postman: Install Postman to test the API endpoints.

• Git: Install Git to clone the repository.

Usage 🚦

Using the Template

1. Navigate to the Template Repository: Visit the Spring Project Template Repository on GitHub.

2. Click on the "Use this template" button:

3. Click on the "Create a new repository" button:

   

4. Provide a Repository Name and Description: Set a name for your new repository based on the template. Optionally, add a description.

5. Complete setting up your repository: Set up your repository by selecting the visibility, adding collaborators, and initializing the repository with a README. Include other setups of your choice then click on the "Create repository" button.

Contributing 🤝

If you find issues or have suggestions for improvements, feel free to open an issue or create a pull request.

Installation

1. Clone the repository:

   git clone https://github.com/mirukibs/Spring-Project-Template.git

2. Navigate to the project directory:

   cd Spring-Project-Template

3. Build the project using Maven:

   mvn clean install

4. Run the application:

   java -jar target/Spring-Project-Template.jar

Configuration ⚙️

Customize the application according to your needs by modifying the configuration files located in the src/main/resources directory.

Database Configuration

Configure your database connection settings in the application.properties file as well.

spring.datasource.url=jdbc:mysql://localhost:3306/{your_db}?user={your_db_username}&password={your_db_password}
spring.datasource.username=${your_db_username}
spring.datasource.password=${your_db_password}
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

---