Skip to content

Latest commit

 

History

History
87 lines (61 loc) · 3 KB

README.md

File metadata and controls

87 lines (61 loc) · 3 KB
Raw

Worktrack

Empowering Workforce Efficiency - One Invoice at a Time

Worktrack is an advanced project management and invoicing tool built specifically for businesses that manage a workforce across various site locations. Designed with the latest version of Laravel and a modern tech stack, Worktrack facilitates seamless worker interactions, from updating personal details to submitting invoices for payment. Its standout features include real-time invoice generation in PDF format, automated email notifications, and meticulous administrative control over worker details and site management.

Worktrack

Key Features:

  • Secure Master Login: Robust backend security to ensure safe access.
  • Worker Management: Add, edit, deactivate, and reactivate worker profiles.
  • Email Automation: Trigger emails automatically when adding workers or for password-less logins.
  • Site Location Management: Add, edit, and delete site locations.
  • Invoice Management: View, submit, and mark invoices as paid or unpaid.
  • PDF Invoicing: Auto-calculate and generate professional PDF invoices with unique identification.
  • Data Privacy: Workers can update their personal and banking details easily and securely.

Project Requirements:

Before installation, ensure your system meets the following requirements:

  • PHP: Version 8.3 or higher.
  • Laravel Framework: Version 11.x is required for backend functionality. Ensure Composer is installed for managing the backend dependencies.
  • Livewire: Version 3.x for building dynamic interfaces efficiently within Laravel.
  • Node.js & NPM: Required for managing front-end packages and running build tools.
  • DaisyUI: Latest compatible version for TailwindCSS, offering a vast collection of pre-styled beautiful UI components.
  • A Database Engine: MySQL, PostgreSQL, SQLite, or SQL Server—Laravel supports these out-of-the-box. Ensure the selected database is running before attempting to migrate the database.
  • A Web Server: Such as Apache or Nginx, if not using Laravel's built-in server.
  • A Mail Server: To handle outgoing emails (or Mailhog for local development testing).

Installation

Clone the repository

git clone https://github.com/saifali-ch/worktrack.git
cd worktrack

Install the project dependencies

composer install
npm install

Configure your environment settings including your database and mail server

cp .env.example .env

Generate your app key

php artisan key:generate

Run the migrations

php artisan migrate

Start the development server

php artisan serve

In a new terminal, launch Vite for asset compilation

npm run dev

Access the application through the browser with the local server address provided, typically http://localhost:8000.

Note: These instructions assume you have PHP, Composer, and NPM installed on your local development environment.