Thread Api Full-Stack Engineering Case Study

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Running Project
3. Usage
4. Swagger Documentation
5. Database
6. Contact

About The Project

A project developed for creating and monitoring sender-receiver threads in real-time. Spring Boot is used to build backend server with PostgreSQL Database and Reactjs is used to build client application with vite plugin. WebSocket is used to reflect instant changes to client, REST API is used for creating and managing resources in server.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

This project can be run using docker-compose.yml file.

Prerequisites

• Java 17+
• Docker
• Maven
• Node.js

Running Project

Run the database via docker-compose.yml file

git clone https://github.com/numankaf/thread-api-case-study.git
cd thread-api-case-study
docker-compose up --build

Run the server

cd threadserver
mvn spring-boot:run

Your server should be running at http://localhost:8080/

Run the server tests

cd threadserver
mvn test

Test Output

Run the client

cd threadclient
npm install
npm run dev

Your client should be running at http://localhost:3001/

(back to top)

Usage

Some example usages of the application:

Create Threads

Update Thread

Start Thread

Logs Page

Dashboard in dark mode

(back to top)

Swagger Documentation

To access Swagger Documentation, navigate to http://localhost:8080/swagger-ui/index.html

(back to top)

Database

You can view the database using pgAdmin interface runnin on docker container, navigate to http://localhost:5050/browser/

(back to top)

Contact

Numan Kafadar - numankafadar97@gmail.com

Project Link: https://github.com/numankaf/thread-api-case-study

(back to top)