hemantDwivedi / authentication-system

This repo contains a Authentication System.

Authentication System

This project is a simple authentication system. It demonstrate how to secure your APIs with spring security with JWT.

Project Structure

├── src/
|   ├── main/
|   |   ├── java/
|   |   |   └── com.assignment.authenticationsystem/
|   |   |       ├── config/
|   |   |       ├── controllers/
|   |   |       ├── dto/
|   |   |       ├── exception/
|   |   |       ├── models/
|   |   |       ├── repository/
|   |   |       ├── security/
|   |   |       └── services/
|   |   |       ├── token/
|   |   └── resources/
|   |       ├── static/
|   |       |── templates/
|   |       └── application.properties/
├── test/
├── pom.xml
└── README.md

Prerequisites

• Java 17
• Maven
• MySQL
• Postman or Talend API Tester

Installation

• Java Development Kit (JDK) 17 or higher: You can download the JDK from Oracle

Getting the Source Code

Clone the repository using Git

• Run the following commands in your Terminal

git clone https://github.com/hemantDwivedi/authentication-system.git

cd authentication-system

Configure Database and Environment

1. Create a new database named 'authentication_system' in your MYSQL.

2. Open project folder in IntelliJ IDEA and wait till to download all neccessary dependencies.

3. Open the application.properties file located in the src/main/resources directory.

4. Update the database connection properties (e.g., spring.datasource.url, spring.datasource.username, spring.datasource.password) to match your database configuration.

5. Right Click on AuthenticationSystemApplication.java located in the src/main/java/com.assignment.authenticationsystem and run the applcation.

Once the application is running, you can test APIs in your Postman or with chrome extention Talend API Tester.

Use Cases

• To create a new user, make a POST request to /api/v1/register with user details (e.g. username, password, email) in the request body.

• To generate JWT Token, make a POST request to /api/v1/login

• GET /api/v1/admin only accessible by ADMIN user.

• To logout, make a GET request to /api/v1/logout. It will logged out user and invalidate the JWT token.

Running Tests

To run tests, run the following command

  mvn test

This command will execute all the unit tests in the project, and the test results will be displayed in the console.