Skip to content

Latest commit

 

History

History
192 lines (135 loc) · 5.56 KB

README.md

File metadata and controls

192 lines (135 loc) · 5.56 KB

🚀 TimeOff.Management

📅 Web application for managing employee absences with style!

✨ Features

🆕 New Features

  • 🎨 Theme selector: Customize your TimeOff.Management experience!
  • 📊 Faster leaves report: Get insights quicker than ever!
  • 📅 Date of request added to leaves table under calendar
  • 🌱 Optimized seed script for better performance
  • 🔧 Cloudflare scripts fix for improved reliability

Existing Features

  • 👥 Multiple views of staff absences: Calendar view, Team view, or Just plain list
  • ⚙️ Customizable to fit your company policy
  • 🔗 Third Party Calendar Integration
  • 🔄 Three Steps Workflow
  • 🔒 Access control with different user types
  • 📊 Data extraction to CSV
  • 📱 Mobile-friendly design
  • 💡 Many other convenient features

🛠️ Installation

☁️ Cloud hosting

Visit http://timeoff.management/ and create a company account to use the cloud-based version.

🏠 Self hosting

# Clone the repository
git clone https://github.com/timeoff-management/application.git timeoff-management
cd timeoff-management

Standalone

npm install
npm start

🐳 Using Docker

# Pull the image
docker pull aliengen/timeoff-management-application:master

# Run the container
docker run -d -p 3000:3000 --env-file ./env --name timeoff aliengen/timeoff-management-application:master

🐳 Using Docker-compose

  1. Copy the example environment file:
cp .env.example .env

  1. Choose your database configuration:

    Option 1: External Database (recommended for production)

    • Set your DATABASE_URL in .env
    • Comment out the postgres service in docker-compose.yaml

    Option 2: Local Database (recommended for development)

    • Comment out DATABASE_URL in .env
    • Uncomment the postgres service in docker-compose.yaml
    • Configure DB_* variables in .env

  2. Start the application:

docker-compose up -d

The application will be available at http://localhost:3000 (or your configured port).

💾 Database Configuration

The application supports two database setup options:

  1. External Database (recommended for production)

    • Uses a hosted database service (e.g., AWS RDS, Neon, Supabase)
    • Set DATABASE_URL in .env
    • Better scalability and maintenance
    • Automatic backups and monitoring
    • Example: DATABASE_URL=postgresql://user:pass@host:5432/dbname?sslmode=require

  2. Local Database (recommended for development)

    • Runs PostgreSQL in a Docker container
    • Data persisted in a Docker volume
    • Easy setup for development
    • Includes optional Adminer for database management
    • Configure using DB_* variables in .env

Choose the option that best fits your needs. For development, the local database option provides a simpler setup. For production, an external database offers better reliability and features.

🌱 Database Seeding

The application includes a powerful seeding system for populating your database with test data. You can run the seed with various options:

# Basic seeding with defaults
npx prisma db seed

# Clear existing data before seeding
npx prisma db seed -- --clear

# Customize the seed data
npx prisma db seed -- --user-count 20 --leaves-multiplier 5

Available seed options:

  • --clear: Clear all data before seeding
  • --user-count or --use-faker: Number of users to create (default: 10)
  • --leaves-multiplier: Multiplier for leaves per user (default: 3)
  • --department-count: Number of departments to create (default: 5)
  • --company-id: Company ID to use (default: 1)
  • --create-default-user: Create default admin user ([email protected]/bob)
  • --date-from: Start date for leaves (YYYY-MM-DD)
  • --date-to: End date for leaves (YYYY-MM-DD)
  • --bank-holiday-count: Number of bank holidays to create (default: 8)
  • --custom-schedule-percent: Percentage of users with custom schedules (default: 30)
  • --uaa: Path to CSV file for user allowance adjustments

The seed creates:

  • Company with departments (some including holidays, others not)
  • Users with various roles (admins, managers)
  • Leave types with fun names
  • Bank holidays within the specified date range
  • Custom work schedules for some users
  • Leave records distributed across the date range

⚙️ Configuration

Configuration can be done through environment variables or JSON configuration files.

🔑 Environment Variables

Here's a summary of key environment variables you can set:

  • BRANDING_URI: URL of the TimeOff.Management application
  • BRANDING_WEBSITE: URL of your company's website
  • HEADER_TITLE: Custom header title for the application
  • DATABASE_URL: Full database URL (for external databases)
  • DB_DATABASE, DB_USER, DB_PASSWORD, DB_HOST: Database configuration (for local databases)
  • DB_DIALECT: Database type (mysql, postgres, sqlite, mssql)
  • OPTION_ALLOW_NEW_REGISTRATIONS: Set to true to allow new company registrations
  • SMTP_*: Various SMTP settings for email configuration
  • CRYPTO_SECRET: Secret key for password hashing
  • SESSION_SECRET: Secret key for session management

For a complete list of options, refer to the .env.example file in the project root.

🧪 Run tests

USE_CHROME=1 npm test

🔄 Updating existing instance

git fetch
git pull origin master
npm install
npm run-script db-update
npm start

🎨 Customization

  • Extend colors for leave types
  • Configure locale-sensitive sorting
  • Force explicit leave type selection

📣 Feedback

Please report any issues or feedback via by opening an issue

Happy time off management! 🌴🏖️