https://github.com/raaz2/sunbase-java-assignment

This project is a Customer Management System designed to perform CRUD operations, including adding, updating, and deleting customers, along with pagination, sorting, and searching features. It integrates JWT-based authentication for security and provides synchronization of customer data from a remote API.
https://github.com/raaz2/sunbase-java-assignment

css hibernate html java javascript jwt mysql rest-template spring-data-jpa spring-security springboot swagger-ui

Last synced: 15 days ago
JSON representation

This project is a Customer Management System designed to perform CRUD operations, including adding, updating, and deleting customers, along with pagination, sorting, and searching features. It integrates JWT-based authentication for security and provides synchronization of customer data from a remote API.

• Host: GitHub
• URL: https://github.com/raaz2/sunbase-java-assignment
• Owner: Raaz2
• Created: 2024-08-26T07:43:02.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-16T07:33:17.000Z (4 months ago)
• Last Synced: 2024-10-31T03:24:58.627Z (2 months ago)
• Topics: css, hibernate, html, java, javascript, jwt, mysql, rest-template, spring-data-jpa, spring-security, springboot, swagger-ui
• Language: Java
• Homepage: https://drive.google.com/file/d/14VQSddfzDqdga7tN2GwMBLDo2Ne4uhzO/view?usp=sharing
• Size: 1.26 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Customer Management System

## Project Overview

This is a customer management system with a Spring Boot backend and an HTML/CSS/JavaScript frontend. It allows adding, updating, deleting, and listing customers, featuring pagination, sorting, and searching. The application includes JWT-based authentication and supports customer data synchronization from a remote API for seamless updates.

## Features

1. **Authentication**:

    - Secure login using JWT tokens.

    - Token validation for accessing customer operations.

2. **Customer Management**:

    - Create, update, delete, and view customer details.

    - Pagination, sorting, and searching customers.

3. **Synchronization**:

    - Sync customers with a remote API.

    - Update existing records or insert new customers if not present in the database.

## Technologies Used

- **Backend**: Spring Boot, Spring Security (JWT Authentication), JPA (Hibernate), MySQL.

- **Frontend**: HTML, CSS, JavaScript.

- **Tools**: Swagger for API documentation.

## Project Structure

- **Backend**: Located under `CustomerCRUD` directory.

- **Frontend**: Located under `FrontEnd/Auth` and `FrontEnd/Customers` directories.

## API Endpoints

### Authentication:

- **Login**: `POST /auth/login`

    - Accepts: `{ "username": "your_username", "password": "your_password" }`

    - Returns: JWT Token

### Customer Management:

- **List Customers**: `GET /customers?page={page}&size={size}&sort={field}&search={query}`

    - Returns: List of customers with pagination, sorting, and optional search.

- **Create Customer**: `POST /customers`

    - Body: Customer object (first name, last name, address, etc.)

- **Update Customer**: `PUT /customers/{id}`

    - Body: Updated customer details.

- **Delete Customer**: `DELETE /customers/{id}`

### Sync:

- **Sync Customers**: `POST /customers/sync`

    - Fetches data from the remote API and synchronizes it with the local database.

## Database Schema

The database consists of the following tables:

1. **Customers**:

    - `id` (Primary Key)

    - `first_name`, `last_name`, `email`, `phone`, `address`, `city`, `state`, `uuid`

2. **Admin** (for authentication):

    - `uuid` (Primary Key)

    - `login_id` (Unique), `password`, `roles` (Admin)

![Database Schema](./Images/database-schema.png)

## Screenshots

### Login Page

![Login Page](./Images/login-page.png)

### Customer List

![Customer List](./Images/customer-list.png)

### Add Customer

![Add Customer](./Images/add-customer.png)

## Swagger Documentation

The API is documented with Swagger for easy testing and understanding.

![Swagger UI](./Images/swagger-ui.jpg)

## Setup Instructions

### Backend Setup

1. Clone the repository.

2. Create a MySQL database called `customer_management`.

3. Update the database credentials in `application.properties`.

4. Run the Spring Boot application using:

   ```

   ./mvnw spring-boot:run

   ```

5. The backend will be running on `http://localhost:8080`.

### Frontend Setup

1. Navigate to the `FrontEnd` folder.

2. Open `index.html` for the login page and `customers.html` for customer management.

### Running the Application

1. Start the backend server.

2. Open the frontend HTML pages in your browser.

3. Register an admin account through the registration page.

4. Log in with the registered admin credentials.

5. Use the customer list and sync features as needed.