CV - Tuan-Dat Tran

A modern, minimalist CV/Resume single-page application with admin panel and persistent storage.

Architecture

┌─────────────────────────────────────────────────────┐
│                 Docker Compose                       │
│  ┌──────────────┐    ┌──────────────────────────┐   │
│  │   Frontend   │    │      Backend API         │   │
│  │   (React)    │───▶│   (Express.js)           │   │
│  │   Port 5173  │    │   Port 3001              │   │
│  └──────────────┘    └───────────┬──────────────┘   │
│                                  │                   │
│                      ┌───────────▼──────────────┐   │
│                      │      SQLite DB           │   │
│                      │   (Volume: ./data)       │   │
│                      └──────────────────────────┘   │
└─────────────────────────────────────────────────────┘

Features

• Modern, responsive design
• Smooth scroll animations with Framer Motion
• Admin panel for easy CV editing (password protected)
• Persistent storage with SQLite
• Docker Compose deployment
• API-based architecture
• Optional Keycloak integration for SSO

Tech Stack

Frontend

• React 18 - UI Library
• Vite - Build Tool
• Tailwind CSS 4 - Styling
• Framer Motion - Animations
• Lucide React - Icons

Backend

• Express.js - API Server
• SQLite - Database
• better-sqlite3 - SQLite driver

Getting Started

Prerequisites

• Node.js 18+
• npm 9+
• Docker & Docker Compose (optional)

Option 1: Docker Compose (Recommended)

# Start all services
docker-compose up -d

# Frontend: http://localhost:5173
# Backend API: http://localhost:3001
# Admin Panel: http://localhost:5173/admin

Option 2: Local Development

# Install frontend dependencies
npm install

# Install backend dependencies
cd backend && npm install && cd ..

# Start backend (terminal 1)
cd backend && npm run dev

# Start frontend (terminal 2)
npm run dev

Environment Variables

Frontend (.env):

VITE_API_URL=http://localhost:3001

Backend (backend/.env):

PORT=3001
DB_PATH=./data/cv.db
USE_KEYCLOAK=false
# Keycloak settings (required if USE_KEYCLOAK=true)
KEYCLOAK_URL=https://keycloak.example.com
KEYCLOAK_REALM=your-realm
KEYCLOAK_CLIENT_ID=cv-admin

Admin Authentication

Simple Mode (Default)

• A random password is generated and printed to the console on server startup
• Look for the "ADMIN PASSWORD" banner in the logs
• Enter this password to access the admin panel

Keycloak Mode

Set USE_KEYCLOAK=true and configure Keycloak environment variables:

USE_KEYCLOAK=true
KEYCLOAK_URL=https://keycloak.example.com
KEYCLOAK_REALM=your-realm
KEYCLOAK_CLIENT_ID=cv-admin

API Endpoints

Method	Endpoint	Auth	Description
GET	/api/cv	No	Get CV data
PUT	/api/cv	Yes	Update CV data
GET	/api/cv/export	No	Export as JSON
POST	/api/cv/import	Yes	Import JSON data
GET	/api/auth/config	No	Get auth configuration
POST	/api/auth/login	No	Login with password
GET	/health	No	Health check

Project Structure

.
├── src/                    # Frontend source
│   ├── components/         # CV components
│   ├── admin/              # Admin panel
│   ├── lib/                # Utilities
│   └── App.jsx
├── backend/                # Backend source
│   ├── routes/             # API routes
│   ├── db/                 # Database
│   └── server.js
├── docker-compose.yml
├── Dockerfile
└── nginx.conf

Testing

# Frontend tests
npm run test:run

# Backend tests
cd backend && npm test

Release Process

This project uses semantic-release for automated versioning and releases.

Conventional Commits

All commit messages must follow the Conventional Commits specification:

<type>(<scope>): <description>

[optional body]

[optional footer]

Commit Types

Type	Description	Version Bump
feat	New feature	Minor
fix	Bug fix	Patch
feat! or BREAKING CHANGE	Breaking change	Major
docs, style, refactor, test, build, ci, chore	Non-release changes	None

Scopes

Available scopes: admin, api, ui, docker, ci, deps, release, auth, skills, experience, education, projects, personal

Release Workflow

1. Push to master branch
2. CI runs tests and linting
3. semantic-release analyzes commits
4. If release needed:
   • Version is bumped in package.json
   • CHANGELOG.md is updated
   • Git tag is created
   • GitHub release is published
   • Docker images are built and pushed

Docker Images

Images are published to both Docker Hub and GitHub Container Registry:

Tag	Description
latest	Latest stable release
v1.2.3	Specific version
staging	Staging environment
nightly, edge	Daily builds from master
YYYY-MM-DD	Dated nightly build

# Pull from Docker Hub
docker pull username/cv-app:latest

# Pull from GHCR
docker pull ghcr.io/owner/cv-app:latest

Environments

Environment	Branch	Trigger
Production	master	semantic-release
Staging	staging	Push to staging
Nightly	master	Daily at 02:00 UTC

Contributing

Contributions are welcome! Please read our Contributing Guide for details.

License

This project is licensed under the MIT License - see the LICENSE file for details.