Skip to content

An authentication app that currently supports token-based authentication and email verification by OTP. This application utilizes Spring Boot for the backend, React for the frontend, and PostgreSQL for the Data Store.

License

Notifications You must be signed in to change notification settings

chintakjoshi/authapp

Repository files navigation

🔐 AuthApp

A modern authentication application supporting token-based authentication and email verification via OTP. Built with:

  • ⚙️ Spring Boot (Backend)
  • 💻 React (Frontend)
  • 🗄️ PostgreSQL (Database)

Authapp CI


🚀 Prerequisites

Make sure you have the following installed:

Tool Version
Java 21.0.6
Maven 3.9.9
NodeJS v22.14.0
Docker Latest

⚙️ Setup Instructions

🔧 Step 1: Configure Environment

  1. Rename .env-sample to .env
  2. Insert your credentials into the environment variables. 👉 To create credentials, click here

🏗️ Step 2: Build and Run

# Install Spring dependencies (Windows)
./mvnw clean package -DskipTests

# Start containers (Spring Boot, React, PostgreSQL)
docker-compose up --build -d

To access the PostgreSQL DB or use BeekeeperStudio/Postico 2(Recommended):

docker exec -it <container_id> psql -U postgres -d authdb

🧠 Architecture Overview

🗺️ High-Level Design

High Level Design


📈 Sequence Diagram

Sequence Diagram


📫 Contact

For any issues or suggestions, please open an issue on the GitHub repo.

Git Commit and Push Checks

This repository includes local git hooks for:

  • Auto-fix trailing/extra whitespace in staged text files
  • Linting (including unused variable and unreachable/dead-code checks) for client/src
  • Secret scanning on staged changes and pushed commits

One-time setup (per clone):

.\scripts\install-git-hooks.ps1

Manual alternatives:

  • git config core.hooksPath .githooks
  • npm --prefix client run lint

About

An authentication app that currently supports token-based authentication and email verification by OTP. This application utilizes Spring Boot for the backend, React for the frontend, and PostgreSQL for the Data Store.

Resources

License

Stars

Watchers

Forks

Packages

No packages published