An open API service indexing awesome lists of open source software.

https://github.com/pasanbhanu/assignment-azbow-tl-2025

Technical Assessment for Azbow
https://github.com/pasanbhanu/assignment-azbow-tl-2025

Last synced: 4 days ago
JSON representation

Technical Assessment for Azbow

Awesome Lists containing this project

README

        

# Lead CRM System | Sample Spring Boot Project

This application showcasing sample api and workflow for a Lead Management system.

## How to Run

### Prerequisites

- Java: Version 17 or 21 (Tested in 21)
- MySQL
- GIT
- Maven
- IDE (Recommended: InteliJ)

### Steps to Run via Command Line

#### Clone the git repository using command line.

```
git clone https://github.com/PasanBhanu/assignment-azbow-tl-2025.git
```

#### Import the database to MySQL

The initial DDM/DML can be found in [documentation](documentation/DB%20Import%20Script.sql) folder.

Start your MySQL server on localhost with port 3306

Create a new database named `azbow`

Import the DDL/DML to the database

#### Update Properties

Update `src/main/resources/application.properties` with your database credentials as required.

```
spring.datasource.url=jdbc:mysql://localhost:3306/azbow # Database URL:PORT/DATABASE_NAME
spring.datasource.username=root # Database USERNAME
spring.datasource.password= # Database PASSWORD
```

#### Run the App

Navigate to the folder and execute below command to build the app. Assuming your JAVA path variable is already setup with recommended java version.

```
mvn clean install
mvn spring-boot:run
```

## How to Test

Once the application is started, you can use [Swagger UI](http://localhost:8080/swagger-ui/index.html) or [Postman Collection](documentation/AZBOW%20Lead%20CRM.postman_collection.json) to test the endpoints.

Sample data is available in postman for testing.

## System Design

The system design documents are located in [documentation](documentation) folder.

ER Diagram: [View ER Diagram](documentation/README.md#er-diagram)

Process Flow Diagram: [View ER Diagram](documentation/README.md#state-diagram)