icehrm/readme.md

IceHrm

IceHrm is a HRM software which enable companies of all sizes to manage HR activities properly.

• IceHrm Demo
• Feature rich version of IceHrm (IceHrmPro) is available at https://icehrm.com/purchase-icehrmpro

Getting started

The easiest way to run IceHrm is using docker

• Install docker on Mac, Windows or Linux https://docs.docker.com/get-docker/

For Linux you need to install docker compose separately here https://docs.docker.com/compose/install/

$ git clone https://github.com/gamonoid/icehrm.git
$ cd icehrm
$ docker-compose -f docker-compose-prod.yaml up -d

• Visit http://localhost:8070/ to load icehrm

You can find database and app data under icehrm/docker/production

When you want to kill the docker containers

docker-compose -f docker-compose-prod.yaml down

For setting up your development environment watch https://www.youtube.com/watch?v=sz8OV_ON6S8

Refer docker documentation for best practices

IceHrm Mobile App (Beta)

Setup to IceHrm App with Your Account

Useful Links

• User Guide: https://icehrm.gitbook.io/icehrm/
• IceHrm Cloud Hosting: https://icehrm.com
• IceHrm Documentation (Opensource and Commercial): http://blog.icehrm.com
• IceHrm Blog: https://icehrm.com/blog
• Purchase IceHrm Pro: https://icehrm.com/modules.php
• Report Issues: https://github.com/gamonoid/icehrm/issues
• Feature Requests: https://bitbucket.org/thilina/icehrm-opensource/issues
• Community Support: http://stackoverflow.com/search?q=icehrm
• IceHrm Opensource Blog: http://icehrm.org

Installation without Docker

• Download the latest release https://github.com/gamonoid/icehrm/releases/latest

• Copy the downloaded file to the path you want to install iCE Hrm in your server and extract.

• Create a mysql DB for and user. Grant all on iCE Hrm DB to new DB user.

• Visit iCE Hrm installation path in your browser.

• During the installation form, fill in details appropriately.

• Once the application is installed use the username = admin and password = admin to login to your system.

Note: Please rename or delete the install folder (/app/install) since it could pose a security threat to your iCE Hrm instance.

Manual Installation

Upgrade from Previous Versions to Latest Version

Refer: http://blog.icehrm.com/docs/upgrade/

Setup IceHrm Development Environment (Docker)

IceHrm uses docker to setup development environment

• Clone icehrm from https://github.com/gamonoid/icehrm.git or download the source

• Build frontend assets (refer to section Building frontend assets)

$ git clone https://github.com/gamonoid/icehrm.git
$ cd icehrm
$ docker-compose up

• Navigate to http://localhost:8080 to load icehrm. (user:admin/pass:admin)

• Make some changes and the changes will be reflected on the above url

• Run e2e (cypress) tests

docker-compose -f docker-compose-testing.yaml up --exit-code-from cypress

• When you are ready to push your changes to production, make sure to build the production images

$ docker-compose -f docker-compose-prod.yaml up -d --build

Setup IceHrm Development Environment (Vagrant)

IceHrm development environment is packaged as a Vagrant box. I includes php7.3, nginx, phpunit and other software required for running icehrm

Preparing development VM with Vagrant

• Clone icehrm from https://github.com/gamonoid/icehrm.git

• Build frontend assets (refer to section Building frontend assets)

• Install Vagrant https://www.vagrantup.com/downloads.html

• Run vagrant up in icehrm root directory (this will download icehrm vagrant image which is ~1 GB)

~ $ vagrant up

• Run vagrant ssh to login to the Virtual machine

~ $ vagrant ssh
~ $ sudo service nginx restart

• Add following entry to the end of the host file to map icehrm domains to VagrantBox (on MacOS and Linux this is /etc/hosts | on windows this is Windows\System32\Drivers\etc\hosts)

192.168.10.12   icehrm.os

• Navigate to http://icehrm.os to load icehrm from Vagrant. (user:admin/pass:admin)

Building frontend assets

• When ever you have done a change to JavaScript or CSS files in icehrm/web you need to rebuild the frontend

• First make sure you have all the dependencies (just doing this once is enough)

$ cd icehrm/web
$ npm install
$ cd ..
$ npm install

• Then run gulp

$ gulp

• For production build use

$ gulp --eprod