Update README.md

Author: SDEParag

README.md

@@ -5,19 +5,22 @@
 ![authentication_system users](https://github.com/SDEParag/Java-backend-Spring-boot-MySQL-login-logout-Authentication-System/assets/137553676/a8424f77-9bbd-4ab7-9dc1-ca586708622d)
 
 # Java-backend-Spring-boot-MySQL-login-logout-Authentication-System
-| Java backend |  Simple authentication  system using Spring Security, JWT, MySQL, and authenticate users with the login and logout  functionalities.
+* | Java backend | Simple authentication  system using Spring Security, JWT, MySQL, and authenticate users with the login and logout  functionalities.
 
-This is a Spring Boot-based authentication system developed for the Woro-media assignment. It provides user registration, login, role-based access control, and logout functionalities.
+* This is a Spring Boot-based authentication system. It provides user registration, login, role-based access control, and logout functionalities.
 
 # Table of Contents
 * Features
 * Technologies Used
 * Project Structure
+* The main packages are
+* Dependencies
 * How to Run
 * Usage
-* Testing
-* Database Configuration
-* Contact
+* Handling Bad Credentials
+* Additional Note
+
+
 
 # Features
 * User registration with username, email, and password
@@ -42,33 +45,37 @@ This is a Spring Boot-based authentication system developed for the Woro-media a
 * The project follows the standard Spring Boot project structure with separate packages for
 * controllers,
 * services,
-*  repositories,
-*   entities,
-*   payloads, and
-*    utils,
-*    security configuration.
+* repositories,
+* entities,
+* payloads, and
+* utils,
+* security configuration.
 
  # The main packages are:
 * com.woromedia.auth.api.controller: Contains the REST API controllers.
 * com.woromedia.auth.api.entity: Contains JPA entity classes.
 * com.woromedia.auth.api.payload: Contains payload classes for request and response.
 * com.woromedia.auth.api.repository: Contains JPA repositories.
 * com.woromedia.auth.api.security: Contains security-related classes like JWT token provider,
-   custom user details service, and authentication filter.
+  custom user details service, and authentication filter.
 * com.woromedia.auth.api.service: Contains service interfaces and their implementations.
 * com.woromedia.auth.api.utils: Contains utility classes.
 
 # Dependencies
 
 The project uses the following dependencies:
 
-* Spring Boot Starter Web: This dependency enables the development of web applications using Spring Boot. It provides essential components for building RESTful APIs.
+* Spring Boot Starter Web: This dependency enables the development of web applications using Spring Boot.
+  It provides essential components for building RESTful APIs.
 
-* Spring Boot Starter Data JPA: This dependency enables JPA (Java Persistence API) support in the application. It simplifies the interaction with the database.
+* Spring Boot Starter Data JPA: This dependency enables JPA (Java Persistence API) support
+   in the application. It simplifies the interaction with the database.
 
-* Spring Boot Starter Security: This dependency provides security support for Spring Boot applications. It allows you to secure your API endpoints and handle authentication and authorization.
+* Spring Boot Starter Security: This dependency provides security support for Spring Boot
+  applications. It allows you to secure your API endpoints and handle authentication and authorization.
 
-* Spring Boot Starter Validation: This dependency enables validation support for the request payloads. It allows you to enforce constraints on the incoming request data.
+* Spring Boot Starter Validation: This dependency enables validation support
+  for the request payloads. It allows you to enforce constraints on the incoming request data.
 
 * JUnit: This dependency is used for writing unit tests.
 
@@ -77,3 +84,109 @@ The project uses the following dependencies:
 * JWT (JSON Web Tokens): This dependency provides support for generating and validating JSON Web Tokens for token-based authentication.
 
 * MySQL Connector/J: This dependency provides the MySQL JDBC driver to connect the application with the MySQL database.
+
+# How to Run
+Follow the steps below to run the application:
+
+* Clone the repository to your local machine.
+* Make sure you have Java 8 and MySQL installed and running.
+* Set up the database by configuring the application.properties file with the correct database URL, username, and password.
+  * (my mysql database is authentication_system , so create only database with any name as per your requirement)
+* Run the application using Intellij IDE.
+
+* This is my application.properties 
+* #Database Configuration
+spring.datasource.url=jdbc:mysql://localhost:3306/authentication_system  <-------Add your database name only
+spring.datasource.username=root          <-------Add your database username
+spring.datasource.password=2022          <-------Add your database password
+
+* #Enable SQL query logging
+spring.jpa.show-sql=true
+
+*  #Hibernate DDL auto
+spring.jpa.hibernate.ddl-auto=update
+
+ * #Hibernate properties
+spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL8Dialect
+
+* #App Properties
+app.jwt-secret=JWTSecretKey
+app.jwt-expiration-milliseconds=604800000
+
+
+
+
+# Usage
+You can interact with the API endpoints using Postman or any other API testing tool.I am using Postman
+
+* Handling API Endpoints with Different Responses
+ 
+* 1 User Registration Endpoint:
+
+ URL:
+* Method POST: http://localhost:8080/api/auth/register
+     Select --> Body --> raw --> JSON
+Request Body:
+
+*  JSON Structure
+ {
+"username": "woromedia_1",
+"password": "password123",
+"email": "woromedia_1@example.com"
+ }
+click on ---> Send  
+* Response: HTTP 200 OK with "User registered successfully" message.
+
+* Bad Credentials: If the provided username or email is already taken, 
+the endpoint returns HTTP 400 Bad Request with an appropriate error message.
+
+* 2 User Login Endpoint:
+URL:
+* Method POST: http://localhost:8080/api/auth/login
+     Select --> Body --> raw --> JSON
+Request Body:
+*  JSON Structure
+{
+  "usernameOrEmail": "woromediaintern_1",
+  "password": "password123"
+}
+
+* Response: HTTP 200 OK with a JWT token in the response body.
+
+* JWT token (On successful login):
+    {
+    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJqb2huX2RvZSIsInJvbGUiOiJST0x
+  FX1VTRVIiLCJpYXQiOjE2MjgxOTQ1OTUsImV4cCI6MTYyODE5ODM5NX0.kiZb0N6dO03t
+       9pPmFgWkGTr5F76vE7w_z-ZrkaCLy2c"
+     }
+  
+* Bad Credentials: If the provided username or email and password combination is invalid, the endpoint returns HTTP 401 Unauthorized with an error message.
+
+* 3 Admin Panel Endpoint:
+
+URL:
+* Method GET : http://localhost:8080/api/auth/admin
+   * Select --> Authorization --> Bearer token --> copy login token  paste in Token like below,
+  Token: [ eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJqb2huX2RvZSIsInJvbGUiOiJST0x
+FX1VTRVIiLCJpYXQiOjE2MjgxOTQ1OTUsImV4cCI6MTYyODE5ODM5NX0.kiZb0N6dO03t9pPmFgWkGTr5F76vE7w_z-ZrkaCLy2c ]
+
+Click on Send
+* Response: HTTP 200 OK with "Admin Panel" message.
+  
+* Authorization Error: If a user without the "ROLE_ADMIN" role tries to access
+ this endpoint, the application returns HTTP 403 Forbidden with an error message.
+
+
+* User Logout Endpoint:
+
+URL:
+* Method POST /api/auth/logout
+* Response: HTTP 200 OK with "Logged out successfully" message
+
+# Handling Bad Credentials
+* If the provided username or email during registration is already taken, the application returns HTTP 400 Bad Request with an appropriate error message.
+
+* If the provided username or email and password combination during login is invalid, the application returns HTTP 401 Unauthorized with an error message.
+  
+# Additional Note
+Remember to configure the application.properties file with the correct database connection details and secret key for JWT token generation.