Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/sandeepkv93/user-management-springboot

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/sandeepkv93/user-management-springboot
Owner: sandeepkv93
Created: 2024-11-12T02:39:28.000Z (about 2 months ago)
Default Branch: main
Last Pushed: 2024-11-12T02:43:51.000Z (about 2 months ago)
Last Synced: 2024-11-12T03:29:06.205Z (about 2 months ago)
Language: Java
Size: 0 Bytes
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

[![Build Status](https://github.com/sandeepkv93/user-management-springboot/actions/workflows/ci.yml/badge.svg)](https://github.com/sandeepkv93/user-management-springboot/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/sandeepkv93/user-management-springboot/branch/main/graph/badge.svg?token=CODECOV_TOKEN_HERE)](https://codecov.io/gh/sandeepkv93/user-management-springboot)

# 🔐 User Management Service

A powerful Spring Boot application for managing users with OAuth2 social login and AWS S3 integration! 🚀

## ✨ Features

### 🎯 Core Features
- 🔑 JWT Authentication & Authorization
- 🌍 OAuth2 Social Login (Google & GitHub)
- 👤 User Profile Management
- 🖼️ Profile Picture Storage (AWS S3)
- 📊 Role-Based Access Control
- 🔄 Token Refresh Mechanism

### 🛠️ Technical Stack
- ☕ Java 21
- 🍃 Spring Boot 3.2
- 🐘 PostgreSQL 16
- 🐳 Docker & Docker Compose
- 📦 LocalStack (S3 Emulation)
- ✈️ Flyway Migrations

## 🏗️ Architecture

```mermaid
flowchart TB
Client[Client Applications]
Auth[Authentication Service]
User[User Service]
S3[S3 Service]
DB[(PostgreSQL)]
S3Store[(S3 Storage)]

style Client fill:#f9f,stroke:#333,stroke-width:4px
style Auth fill:#bbf,stroke:#333,stroke-width:2px
style User fill:#bbf,stroke:#333,stroke-width:2px
style S3 fill:#bbf,stroke:#333,stroke-width:2px
style DB fill:#bfb,stroke:#333,stroke-width:2px
style S3Store fill:#bfb,stroke:#333,stroke-width:2px
```

### 🔄 Authentication Flow

```mermaid
sequenceDiagram
actor User
participant Client
participant Auth
participant DB

User->>Client: Login Request
Client->>Auth: Authenticate
Auth->>DB: Validate Credentials
DB-->>Auth: User Data
Auth-->>Client: JWT + Refresh Token
Client-->>User: Login Success

Note over User,DB: Token Refresh Flow
Client->>Auth: Refresh Token
Auth->>DB: Validate Refresh Token
DB-->>Auth: Token Valid
Auth-->>Client: New JWT
```

## 🚀 Getting Started

### 📋 Prerequisites
- ☕ Java 21
- 📦 Maven
- 🐳 Docker & Docker Compose
- 🐘 PostgreSQL 16
- 💻 Your favorite IDE!

### 🔧 Setup

1. **📥 Clone the Repository**
```bash
git clone
cd user-management
```

2. **🐳 Start Infrastructure**
```bash
docker-compose up -d
```

3. **🎯 Initialize S3**
```bash
chmod +x scripts/init-localstack.sh
./scripts/init-localstack.sh
```

4. **⚙️ Configure Application**

Create `application.yml` with your settings:
```yaml
spring:
datasource:
url: jdbc:postgresql://localhost:5432/user_management
username: user
password: password

app:
jwt:
secret: ${JWT_SECRET:your-secret-key}
aws:
s3:
bucket-name: user-profiles
```

5. **🚀 Build & Run**
```bash
mvn clean install
mvn spring-boot:run
```

## 🔌 API Reference

### 🔐 Authentication

#### 📝 Register
```http
POST /api/auth/signup
{
"username": "cooluser123",
"email": "[email protected]",
"password": "secure123!"
}
```

#### 🔑 Login
```http
POST /api/auth/login
{
"email": "[email protected]",
"password": "secure123!"
}
```

### 👤 User Management

#### 📱 Get Profile
```http
GET /api/users/me
Authorization: Bearer
```

#### 🖼️ Update Profile Picture
```http
POST /api/users/me/profile-picture
Authorization: Bearer
Content-Type: multipart/form-data
```

### 🌐 OAuth2 Login

#### 🔷 Google
```http
GET /oauth2/authorization/google
```

#### 🐱 GitHub
```http
GET /oauth2/authorization/github
```

## 🔒 Security Features

### 🔐 Authentication
- 🎟️ JWT Tokens (1 hour validity)
- 🔄 Refresh Tokens (30 days validity)
- 🔒 BCrypt Password Encryption

### 👮 Authorization
- 👥 Role-Based Access Control
- 🛡️ Method-Level Security
- 🚫 CORS Protection

## 🧪 Testing

```bash
# 🧪 Run all tests
mvn test

# 📊 Generate coverage report
mvn verify
```

## 🔧 Development

### 📝 Code Style
```bash
# 🎨 Format code
mvn com.spotify.fmt:fmt-maven-plugin:format
```

### 📚 Database Migrations
```bash
# 🔄 Run migrations manually
mvn flyway:migrate
```