AuctiX

Online auction platform

Formating

Prettier is configured to format the staged files and commit. using husky pre-commit hook to skip the formatting use the git commit with -n or --no-verify flag also add files to .prettierignore file to ignore the formatting

Setup

Backend setup

Pre-requisites

• Java 21
• Maven
• Docker

Running the backend

1. Change directory to backend

cd backend

2. Start the docker container for the database

docker compose up

3. Run the backend

./mvnw spring-boot:run 
### without wrapper
mvn spring-boot:run

Creating migrations for the database using Flyway

Flyway is used to manage the database migrations in AuctiX application.

The migrations are stored in the backend/src/main/resources/db/migration directory.

The migrations should be created in the following format:

V{version}__{description}.sql

Example:

• V1__create_user_table.sql

  CREATE TABLE user (
      id SERIAL PRIMARY KEY,
      username VARCHAR(255) NOT NULL,
      password VARCHAR(255) NOT NULL
  );

• V2__add_profile_pic_url_col_to_user_table.sql

  ALTER TABLE user
  ADD COLUMN profile_pic_url VARCHAR(255);

The migrations will be applied to the database when the application is started.

Authentication Backend API

Register a User

Endpoint:
POST /api/auth/register

Request Body:

{
  "email": "[email protected]",
  "username": "exampleUser",
  "password": "securePassword",
  "role": "SELLER"
}

Response:

200 OK → User registered successfully

400 Bad Request → Invalid request

Login

Endpoint: POST /api/auth/login

Request Body:

{
  "email": "[email protected]",
  "password": "securePassword"
}

Response:

200 OK → Returns JWT token

401 Unauthorized → Email or password incorrect

Use JWT for Authentication

Include the token in the Authorization header for protected routes.

Example:

Authorization: Bearer <your-jwt-token>