YBoard - Teacher Management Platform

🎯 About the Project

YBoard is a comprehensive management platform specifically developed for Ynov Toulouse to handle in-depth candidate management and teacher assignment across all modules and programs of the school.

This application enables centralized and efficient management of teachers/instructors, their assignment to various educational modules, and workload tracking across all Ynov programs.

🌟 Key Features

Teacher Management: Create, modify, and delete instructor profiles
Module Management: Organize educational modules by program
Program Management: Administer different programs and specialties
CV Management: Upload, view, and manage PDF resumes for teachers
- 📄 PDF Upload: Secure upload of teacher CVs (5MB max)
- 👁️ CV Viewing: In-browser PDF preview
- 🔄 CV Replacement: Easy replacement of existing CVs
- 🗑️ CV Deletion: Option to remove uploaded CVs
Relationship System: Assign teachers to modules with 3 statuses:
- 🟢 Ongoing: Currently assigned teachers
- 🟡 Potential: Potential teachers (under evaluation)
- 🔵 Selected: Selected teachers (validated for assignment)
Workload Management: Precise tracking of each instructor's hourly volume
Drag & Drop Interface: Intuitive assignment management through drag-and-drop
Secure Authentication: Login system with JWT
Interactive Dashboards: Overview of assignments and statistics

🎓 Ynov Context

This platform addresses the specific needs of Ynov Toulouse school to:

Optimize pedagogical human resource management
Facilitate instructor assignment to different modules
Ensure precise workload tracking
Improve visibility on assignments by program
Simplify the candidate application and selection process

🛠️ Technical Architecture

Technology Stack

Frontend: Next.js 15 + React 19 + TypeScript
Backend: tRPC + Next.js API Routes
Database: PostgreSQL + Prisma ORM
UI/UX: Mantine UI + Tailwind CSS
Authentication: JWT + bcrypt
Drag & Drop: @dnd-kit
Validation: Zod
Containerization: Docker + Docker Compose

📊 Database Schema

erDiagram
    Users {
        uuid Id_Users PK
        varchar_50 firstname "NOT NULL"
        varchar_50 lastname "NOT NULL"
        varchar_50 email "NOT NULL"
        varchar_255 password "NULL"
        timestamp last_connected "NULL"
    }

    Promos {
        uuid Id_Promo PK
        varchar_50 level "NOT NULL"
        varchar_50 specialty "NOT NULL"
    }

    Modules {
        uuid Id_Module PK
        varchar_50 name "NOT NULL"
    }

    Teacher {
        uuid Id_Teacher PK
        varchar_50 lastname "NOT NULL"
        varchar_50 firstname "NOT NULL"
        varchar_50 status "NULL"
        varchar_50 diploma "NULL"
        text comments "NULL"
        decimal_5_2 rate "NULL"
        varchar_50 email_perso "NULL"
        varchar_50 email_ynov "NULL"
        varchar_10 phone_number "NULL"
        varchar_255 cv_filename "NULL"
        timestamp cv_uploaded_at "NULL"
    }

    PromoModules {
        uuid Id_PromoModules PK
        uuid Id_Module FK "NOT NULL"
        uuid Id_Promo FK "NOT NULL"
        int workload "NOT NULL"
    }

    ongoing {
        uuid Id_Teacher FK "NOT NULL"
        uuid Id_PromoModules FK "NOT NULL"
        int workload "NOT NULL"
        decimal_5_2 rate "NULL"
    }

    potential {
        uuid Id_Teacher FK "NOT NULL"
        uuid Id_PromoModules FK "NOT NULL"
        int workload "NOT NULL"
        date interview_date "NULL"
        text interview_comments "NULL"
        boolean decision "NULL"
        decimal_5_2 rate "NULL"
    }

    selected {
        uuid Id_Teacher FK "NOT NULL"
        uuid Id_PromoModules FK "NOT NULL"
        int workload "NOT NULL"
        decimal_5_2 rate "NULL"
    }

    Promos ||--o{ PromoModules : "has"
    Modules ||--o{ PromoModules : "belongs to"
    Teacher ||--o{ ongoing : "assigned to"
    Teacher ||--o{ potential : "candidate for"
    Teacher ||--o{ selected : "selected for"
    PromoModules ||--o{ ongoing : "contains"
    PromoModules ||--o{ potential : "contains"
    PromoModules ||--o{ selected : "contains"

� File Storage & CV Management

Uploaded files structure

uploads/
└── cv/                          # CV directory
    ├── [uuid]_[timestamp].pdf   # File naming format
    └── ...

Storage configuration

Development:

CVs are stored locally in ./uploads/cv/
Automatic directory creation if needed

Production (Docker):

Persistent volume cv_storage mounted on /app/uploads/cv
Permissions configured for nextjs user
Backup recommended via docker cp

CV Management Features

Supported formats:

✅ PDF only
✅ Maximum size: 5MB
✅ Automatic naming with UUID + timestamp

Features:

📤 Secure upload: MIME type and size validation
👁️ Viewing: Opens in new tab
🔄 Replacement: Automatic deletion of old file
🗑️ Deletion: File + database reference removal
📊 Metadata: Upload date and filename stored

API Endpoints:

POST /api/cv/upload: Upload new CV
GET /api/cv/[filename]: Retrieve/view CV
DELETE /api/cv/[filename]: Delete CV

�🗂️ Project Structure

src/
├── app/                      # App Router (Next.js 13+)
│   ├── api/                 # API routes
│   │   ├── cv/              # CV management endpoints
│   │   │   ├── upload/      # CV upload endpoint
│   │   │   └── [filename]/  # CV view/delete endpoint
│   │   └── trpc/            # tRPC API routes
│   ├── login/               # Login page
│   ├── modules/             # Module management
│   │   ├── details/         # Module details and assignments
│   │   └── delete/          # Module deletion
│   ├── teachers/            # Teacher management
│   │   ├── details/         # Profile and assignments
│   │   └── delete/          # Teacher deletion
│   ├── promos/              # Program management
│   └── users/               # User management
├── components/              # Reusable components
│   ├── AppLayout.tsx        # Main layout
│   ├── Sidebar.tsx          # Side navigation
│   └── modals/              # Creation modals
├── contexts/                # React contexts
│   ├── AuthContext.tsx      # Authentication
│   └── ModalContext.tsx     # Modal management
├── server/                  # tRPC backend
│   ├── api/                 # API route definitions
│   └── db.ts                # Prisma configuration
├── trpc/                    # tRPC client configuration
└── types/                   # TypeScript types
uploads/                     # File storage (not tracked in git)
└── cv/                      # CV files storage

🚀 Getting Started

📋 Prerequisites

Node.js 22+
npm 10+
PostgreSQL 15+
Docker (optional)

🔧 Installation and Setup

1. Clone the project

git clone <repository-url>
cd SourcingIntervenantsYnov

2. Install dependencies

npm install

3. Environment configuration

Create a .env file at the root:

# Database
DATABASE_URL="postgresql://postgres:password@localhost:5432/sourcing_intervenants_ynov"

# Authentication
JWT_SECRET="your-super-secret-jwt-key-change-this-in-production"

# Environment
NODE_ENV="development"

4. Database setup

# Generate Prisma client
npm run db:generate

# Apply migrations
npm run db:migrate

# (Optional) Open Prisma Studio
npm run db:studio

🏃‍♂️ Development

Start in development mode

npm run dev

The application will be accessible at http://localhost:3000

Available scripts

# Development
npm run dev              # Start with Turbo
npm run build            # Production build
npm run start            # Production start
npm run preview          # Build + Start

# Database
npm run db:generate      # Generate Prisma client
npm run db:migrate       # Apply migrations
npm run db:push          # Push schema (dev)
npm run db:studio        # Prisma Studio interface

# Code quality
npm run check            # Lint + TypeScript
npm run lint             # ESLint
npm run lint:fix         # ESLint auto-fix
npm run typecheck        # TypeScript check
npm run format:check     # Prettier check
npm run format:write     # Prettier format

🐳 Docker Deployment

Docker Compose (Recommended)

# Complete startup (app + database)
docker-compose up -d

# Logs
docker-compose logs -f

# Stop
docker-compose down

# Stop and remove volumes (⚠️ This will delete uploaded CVs and database data)
docker-compose down -v

📁 Persistent Data Storage:

Docker Compose deployment automatically configures two persistent volumes:

postgres_data: PostgreSQL database data
cv_storage: Uploaded CV files (stored in /app/uploads/cv)

🔒 CV Backup:

# Backup uploaded CVs
docker cp $(docker-compose ps -q app):/app/uploads/cv ./cv_backup

# Restore CVs from backup
docker cp ./cv_backup/. $(docker-compose ps -q app):/app/uploads/cv/

Manual Docker

# Build image
docker build -t yboard-app .

# Run with CV storage volume
docker run -p 3000:3000 \
  -v yboard_cv_storage:/app/uploads/cv \
  -e DATABASE_URL="postgresql://postgres:password@host.docker.internal:5432/sourcing_intervenants_ynov" \
  -e JWT_SECRET="your-secret-key" \
  yboard-app

🌐 Production

Production environment variables

DATABASE_URL="postgresql://user:password@host:5432/database"
JWT_SECRET="your-production-secret-key"
NODE_ENV="production"

Build and deployment

# Production build
npm run build

# Production start
npm run start

🔐 First Login

Create an admin user directly in the database
Login at /login
Access the main dashboard

📚 Useful Resources

Prisma Documentation: https://www.prisma.io/docs
tRPC Documentation: https://trpc.io/docs
Next.js Documentation: https://nextjs.org/docs
Mantine Documentation: https://mantine.dev/

🤝 Contributing

This project was specifically developed for Ynov Toulouse. For any modifications or improvements, please contact me.

Name		Name	Last commit message	Last commit date
Latest commit History 12 Commits
.github/workflows		.github/workflows
img		img
prisma		prisma
public		public
src		src
.dockerignore		.dockerignore
.env.example		.env.example
.gitignore		.gitignore
Dockerfile		Dockerfile
README.md		README.md
docker-compose.yml		docker-compose.yml
eslint.config.js		eslint.config.js
middleware.ts		middleware.ts
next.config.js		next.config.js
package-lock.json		package-lock.json
package.json		package.json
postcss.config.js		postcss.config.js
prettier.config.js		prettier.config.js
tsconfig.json		tsconfig.json

Folders and files

Latest commit

History

Repository files navigation

YBoard - Teacher Management Platform

🎯 About the Project

🌟 Key Features

🎓 Ynov Context

🛠️ Technical Architecture

Technology Stack

📊 Database Schema

� File Storage & CV Management

Uploaded files structure

Storage configuration

CV Management Features

�🗂️ Project Structure

🚀 Getting Started

📋 Prerequisites

🔧 Installation and Setup

1. Clone the project

2. Install dependencies

3. Environment configuration

4. Database setup

🏃‍♂️ Development

Start in development mode

Available scripts

🐳 Docker Deployment

Docker Compose (Recommended)

Manual Docker

🌐 Production

Production environment variables

Build and deployment

🔐 First Login

📚 Useful Resources

🤝 Contributing

📝 License

About

Topics

Resources

Uh oh!

Stars

Watchers

Forks

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages