https://github.com/chocomeow/overtime-toil-tracker
https://github.com/chocomeow/overtime-toil-tracker
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/chocomeow/overtime-toil-tracker
- Owner: ChocoMeow
- License: mit
- Created: 2025-08-06T09:00:45.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-08-30T02:07:42.000Z (10 months ago)
- Last Synced: 2025-08-30T04:12:44.966Z (10 months ago)
- Language: JavaScript
- Size: 231 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Overtime-Toil-Tracker
A comprehensive web application for managing employee overtime, leave requests, and TOIL (Time Off In Lieu) tracking. Built with Vue.js frontend and Node.js/Express backend with SQLite database.
## 📺 Screenshot
## 🚀 Features
### 👥 User Management
- Employee registration and authentication
- Role-based access control (Employee, Manager, Admin)
- User profile management
### 📅 Leave Management
- Submit and track leave requests
- Multiple leave types with color coding
- Leave balance tracking
- Manager approval workflow
### ⏰ Overtime Tracking
- Log overtime hours with descriptions
- Categorize overtime (Regular, Emergency, Weekend, Holiday)
- Manager approval system
- Overtime summary and reports
### 🎯 TOIL (Time Off In Lieu) System
- Earn TOIL from approved overtime
- Track TOIL balance and expiry dates
- Use TOIL for time off
- TOIL usage tracking
### 📊 Reporting & Analytics
- Dashboard with key metrics
- Leave and overtime summaries
- TOIL balance reports
- Admin approval interface
## 🛠️ Tech Stack
### Frontend
- **Vue.js 3** - Progressive JavaScript framework
- **TypeScript** - Type-safe JavaScript
- **Vite** - Fast build tool and dev server
- **Pinia** - State management
- **Vue Router** - Client-side routing
- **Reka UI** - Modern UI components
- **Tailwind CSS** - Utility-first CSS framework
- **Lucide Vue** - Beautiful icons
### Backend
- **Node.js** - JavaScript runtime
- **Express.js** - Web application framework
- **TypeScript** - Type-safe JavaScript
- **Prisma** - Database ORM
- **SQLite** - Lightweight database
- **JWT** - JSON Web Tokens for authentication
- **bcrypt** - Password hashing
## 🚀 Quick Start
### Prerequisites
- Node.js (v20 or higher)
- npm or yarn package manager
### 1. Clone the Repository
```bash
git clone https://github.com/ChocoMeow/Overtime-Toil-Tracker.git
cd Overtime-Toil-Tracker
```
### 2. Backend Setup
```bash
# Navigate to backend directory
cd backend
# Install dependencies
npm install
# Set up environment variables
cp .env.example .env
# Edit .env with your configuration
# Set up database
npx prisma generate
npx prisma migrate dev
# Start development server
npm run dev
```
### 3. Frontend Setup
```bash
# Navigate to frontend directory
cd frondend
# Install dependencies
npm install
# Set up environment variables
cp .env.example .env
# Edit .env with your API URL
# Start development server
npm run dev
```
### 4. Access the Application
- Frontend: http://localhost:5173
- Backend API: http://localhost:3001
- Health Check: http://localhost:3001/health
## ⚙️ Environment Configuration
### Backend Environment (`backend/.env`)
```env
DATABASE_URL="file:./dev.db"
JWT_SECRET="your-super-secret-jwt-key"
PORT=3001
CORS_ORIGIN="http://localhost:5173"
```
### Frontend Environment (`frondend/.env`)
```env
VITE_API_URL="http://localhost:3001/api"
```
## 📝 License
This project is licensed under the MIT License - see the LICENSE file for details.