epiform

A web-based progress tracker for French administrative procedures, designed for international students @ EPITA.

Wiki · English · Français

Features

• Modern UI: Clean interface featuring a cursor glow effect and zero-reloading transitions for a seamless UX.
• Browser Persistence: Uses localStorage to save progress automatically without requiring a server account.
• Smart Sorting: Procedures are categorized by priority and urgency.
• Responsive Design: Optimized for both desktop and mobile layouts.
• FR / EN Translation: Full bilingual support.
• Dark Theme: Native dark mode support.

> **Note:** The browser's `localStorage` eliminates the need for a backend, keeping user data strictly on their device for privacy.

Tech Stack

• Core: React 19, Vanilla JS
• Routing: React Router 7
• Build Tool: Vite
• Styling: TailwindCSS
• Icons: Lucide React
• Deployment: Vercel

Installation

Prerequisites: Node.js v20+

1. Clone the repository

git clone https://github.com/s-amiour/epiform.git
cd epiform

2. Install dependencies

npm install

3. Start development server

npm run dev

4. Live site at http://localhost:3001

Project Structure

├── docs/                    # Documentation-related files
├── public/                  # Static assets
├── src/
│   ├── assets/images/       # Global images
│   ├── components/          # React components
│   │   └── utils/           # Utilities for components
│   ├── App.jsx              # Main Layout
│   ├── index.css
│   ├── main.jsx             # Entry point
│   └── proceduresdata.json  # Data
├── README.md           
├── README_FR.md             # Documentation in French
├── vercel.json              # Deployment configuration for Vercel
├── vite.config.js           # Configuration for the Vite bundler
└── ...

Contributing

We welcome contributions, especially from people who may have experienced situations not mentioned in our project.

Want to add a new procedure? You don't need to be a React expert. Simply edit src/proceduresdata.json to add new entries.

1. Check the Wiki to understand the architecture in more detail
2. Fork project
3. Create your feature branch (git checkout -b feat/amazingFeature)
4. Commit your changes (git commit -m "feat(<scope>): add amazingFeature")
5. Push to branch (git push origin feat/amazingFeature)
6. Open a pull request

Inspiration

French bureaucracy is notorious for being complex, opaque, and paper-heavy ("La Paperasse"), making it a major pain point for international students. A dedicated tool for EPITA students solves a very specific, high-value problem.

Found a bug? Signal It