adaugochi / employee-management-system

About Laravel

Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:

• Simple, fast routing engine.
• Powerful dependency injection container.
• Multiple back-ends for session and cache storage.
• Expressive, intuitive database ORM.
• Database agnostic schema migrations.
• Robust background job processing.
• Real-time event broadcasting.

Laravel is accessible, powerful, and provides tools required for large, robust applications.

Employee Management System (EMS)

EMS is a web-based solution that help organizations manage their employees. This application allows employees and an admin to use the system. The administrator create user accounts and the application helps in salary payments.

User Types

• Admin
• Employee

Requirements

• PHP - ^7.4
• node
• npm
• composer

Clone

You have to clone this repo using either HTTPS or SSH

• HTTPS

git clone https://github.com/adaugochi/employee-management-system.git

• SSH

git clone [email protected]:adaugochi/employee-management-system.git

Environment Variables

Make a copy of .env.example to .env in the env directory. Fill in the with appropriate details. Examples

## Database
DB_DATABASE=laravel
DB_USERNAME=root
DB_PASSWORD=

## Mail (You can create an account with mailtrap.io)
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS=null

## Default Admin creds
DEFAULT_ADMIN_EMAIL=[email protected]
DEFAULT_ADMIN_PASSWORD=11111111
DEFAULT_ADMIN_PHONE_NUMBER="08101111111"
DEFAULT_ADMIN_INTL_NUMBER="[phone]"

Install Dependencies

Composer Dependencies

composer install

Node.js Dependencies

npm install

Virtual Host Setup (optional)

Windows Link 1 Link 2

Mac Link 1 Link 2

Debian Linux Link 1 Link 2

Sample Virtual Host Config for Apache

<VirtualHost *:80>
    ServerAdmin [email protected]
    DocumentRoot "<WebServer Root Dir>/employee-management-system/public"
    ServerName local.manup.com
    <Directory <WebServer Root Dir>/employee-management-system/public>
       AllowOverride all
       Options -MultiViews
      Require all granted
    </Directory>
</VirtualHost>

Setup Database

You can either create your own database and run migration or simply import the ems.sql file that is in the root directory

Create Database

CREATE DATABASE ems CHARACTER SET utf8 DEFAULT COLLATE utf8_unicode_ci;

Migration

# run migration
php artisan migrate

# rollback migration (optional)
php artisan migrate:rollback

# refresh migration (optional)
php artisan migrate:refresh

Specify Path to Migration File (optional)

# run migration
php artisan migrate --path=database/migrations/filename.php

# rollback migration
php artisan migrate:rollback --path=database/migrations/filename.php

# refresh migration
php artisan migrate:refresh --path=database/migrations/filename.php

Seeding

This will help seed the default admin credentials into the database

php artisan db:seed --class=UserSeeder

Compile SCSS to CSS (During Development)

You can compile your scss file to css using:

npm run watch

Starting the Application (optional)

You can run the application in development mode by running this command from the project directory:

php artisan serve

The command above can be skipped if you already created a virtual host

Author of README.md

• Adaa Mgbede [email protected] Linked In

Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by the Code of Conduct.