From dbb277b7f2d69423917df70d54a23eb7d2530fca Mon Sep 17 00:00:00 2001 From: Fayre18 <72248220+Fayre18@users.noreply.github.com> Date: Sat, 17 Oct 2020 13:16:48 +0530 Subject: [PATCH] Update readme.md --- readme.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/readme.md b/readme.md index 504ea26..025b9e2 100644 --- a/readme.md +++ b/readme.md @@ -5,22 +5,22 @@ ## Description -HRM is a web based HR management system that covers the needs of SMEs for managing their employees and the recruitment process. The system is built on [Laravel 5.3](https://laravel.com/docs/5.3). +HRM is a web-based HR management system that covers the needs of SMEs for managing their employees and the recruitment process. The system is built on [Laravel 5.3](https://laravel.com/docs/5.3). Available functions: * Settings (General settings related to features that will be used in the system. It includes setting up document templates for later use.) -* PIM (Personal information management for employees and candidates.) -* Leave (Managing leave and defining holidays.) -* Time (Managing time logs and projects.) -* Recruitment (Managing recruitment reports.) -* Discipline (Defining disciplinary cases for inadequate behaviours.) +* PIM (Personal Information Management for employees and candidates) +* Leave (Managing leave and defining holidays) +* Time (Managing time logs and projects) +* Recruitment (Managing recruitment reports) +* Discipline (Defining disciplinary cases for inadequate behaviours) ## Installation The system is built on top of Laravel 5.3, so to proceed with the installation you will need a machine that complies with [Laravel's requirements](https://laravel.com/docs/5.3/installation). Follow the steps below to quickly set up the application. -1. Dedicate a domain/subdomain to the project and set up the virtual host accordingly. +1. Dedicate a domain/subdomain to the projects and set up the virtual host accordingly. 2. On the command line, run `composer install` to install all dependencies, and then `composer dump` to autoload the needed files. 3. Create a database that will be used for the application purposes. 4. Copy the .env.example file on the root of the app to a new file named .env. Update the database fields according to your local setup and set the APP_KEY. @@ -29,7 +29,7 @@ The system is built on top of Laravel 5.3, so to proceed with the installation y 7. Possible errors: if the app is not working at this point, there are probably some permission errors. * Check `/storage` permissions - the storage folder on the root of the app should be writable by the application. Make sure the permissions are set correctly. * Check `/bootstrap/cache` permissions - this folder should also be writable. Make sure the permissions are set correctly. -8. At this point you should have the app up and running. Hit `yourdomain/register` to open the registration screen for creating an admin user. This is a one time setup and the credentials set here will be used for authenticating before using the system. +8. At this point, you should have the app up and running. Hit `yourdomain/register` to open the registration screen for creating an admin user. This is a one time setup and the credentials set here will be used for authenticating before using the system. #### Docker installation 1. Install Docker and Docker Compose for the operating system of your choice. @@ -46,7 +46,7 @@ The system is built on top of Laravel 5.3, so to proceed with the installation y ## Contributing -We encourage you to contribute to HRM! Please check out the [Contributing guide](contributing.md) for guidelines about how to proceed. +We encourage you to contribute to HR Management System! Please check out the [Contributing guide](contributing.md) for guidelines about how to proceed. ## License