Skip to content

Improve Docs #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve Docs #59

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand All @@ -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

Expand Down