Horilla

https://docs.horilla.com/hr/technical/v2.0/
Admin
Horilla is a free and open-source HRMS (Human Resource Management System) software that provides...
Tokens:2,125
Snippets:24
Trust Score:8.7
Update:11 months ago
Show doc for...
Tokens:
Raw
### Install Python Dependencies with Pip

Source: https://docs.horilla.com/hr/technical/v2.0/index

Installs all necessary Python packages listed in the 'requirements.txt' file. This step is crucial for the project to function correctly. It requires pip to be installed.

```bash
pip install -r requirements.txt
```

--------------------------------

### Install mysqlclient for Django MySQL Integration

Source: https://docs.horilla.com/hr/technical/v2.0/index

Installs the `mysqlclient` package, a Python interface for MySQL, enabling Django to interact with MySQL databases. This is a prerequisite for configuring MySQL in Django.

```bash
pip install mysqlclient
```

--------------------------------

### Install pycairo Dependencies on Ubuntu/macOS

Source: https://docs.horilla.com/hr/technical/v2.0/index

Provides commands to install the libcairo2-dev package on Ubuntu or py3cairo via Homebrew on macOS, which may be required to resolve issues with the pycairo package during dependency installation.

```bash
sudo apt-get install libcairo2-dev
```

```bash
brew install py3cairo
```

--------------------------------

### Install PostgreSQL Adapter for Django

Source: https://docs.horilla.com/hr/technical/v2.0/index

Installs the 'psycopg2' package, which is the PostgreSQL database adapter for Python. This is required to connect Django to a PostgreSQL database.

```bash
pip install psycopg2
```

--------------------------------

### Database Migrations for Horilla

Source: https://docs.horilla.com/hr/technical/v2.0/index

Applies database migrations to set up the necessary tables and schema for the Horilla application. This command is essential after initial setup or when database structure changes.

```bash
python manage.py makemigrations
python manage.py migrate
```

--------------------------------

### Clone Horilla Repository using Git

Source: https://docs.horilla.com/hr/technical/v2.0/index

This command clones the Horilla project repository from GitHub to your local machine. Ensure you have Git installed and configured.

```bash
git clone https://github.com/horilla-opensource/horilla.git
```

--------------------------------

### Install cx_Oracle for Django Oracle Integration

Source: https://docs.horilla.com/hr/technical/v2.0/index

Installs the `cx_Oracle` package, a Python interface for Oracle databases, enabling Django to connect to and manage Oracle databases. This is required before configuring Oracle in Django.

```bash
pip install cx_Oracle
```

--------------------------------

### Run Horilla Development Server

Source: https://docs.horilla.com/hr/technical/v2.0/index

Starts the local development server for the Horilla application. By default, it runs on port 8000. You can specify a different port number.

```bash
python manage.py runserver
# To run on a specific port:
# python manage.py runserver <port_number>
```

--------------------------------

### Collect Static Files

Source: https://docs.horilla.com/hr/technical/v2.0/index

Gathers all static files (CSS, JavaScript, images) from various apps into a single directory specified by 'settings.STATIC_ROOT'. This is crucial for deployment.

```bash
python manage.py collectstatic
```

--------------------------------

### Configure Django Settings for Oracle Database

Source: https://docs.horilla.com/hr/technical/v2.0/index

Sets up the database connection parameters for Oracle within Django's `settings.py` file. This involves specifying the engine, name, user, password, host, and port for the Oracle database.

```python
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.oracle',
        'NAME': '<database_name>',
        'USER': '<database_user>',
        'PASSWORD': '<database_password>',
        'HOST': '<database_host>',
        'PORT': '<database_port>',
    }
}
```

--------------------------------

### Configure Django Settings for MySQL Database

Source: https://docs.horilla.com/hr/technical/v2.0/index

Sets up the database connection details for MySQL within Django's `settings.py` file. Requires specifying engine, name, user, password, host, and port for the MySQL server.

```python
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': '<database_name>',
        'USER': '<database_user>',
        'PASSWORD': '<database_password>',
        'HOST': '<database_host>',
        'PORT': '<database_port>',
    }
}
```

--------------------------------

### Configure Django Settings for SQLite Database

Source: https://docs.horilla.com/hr/technical/v2.0/index

Configures Django to use an SQLite database by specifying the engine and the path to the database file within `settings.py`. Creates a `db.sqlite3` file in the project directory by default.

```python
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': BASE_DIR / 'db.sqlite3',
    }
}
```

--------------------------------

### Create Horilla Admin User

Source: https://docs.horilla.com/hr/technical/v2.0/index

Creates an administrator account for the Horilla application. This is similar to Django's 'createsuperuser' command and also creates a related employee record.

```bash
python manage.py createhorillauser
```

--------------------------------

### Configure PostgreSQL Database in Django Settings

Source: https://docs.horilla.com/hr/technical/v2.0/index

Defines the database connection settings for PostgreSQL within Django's 'settings.py' file. Replace placeholder values with your actual PostgreSQL credentials.

```python
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': '<database_name>',
        'USER': '<database_user>',
        'PASSWORD': '<database_password>',
        'HOST': '<database_host>',
        'PORT': '<database_port>',
    }
}
```

--------------------------------

### Compile Translation Messages

Source: https://docs.horilla.com/hr/technical/v2.0/index

Compiles translation message files (.po) into machine-readable format (.mo) for internationalization. This command is necessary for displaying Horilla in different languages.

```bash
python manage.py compilemessages
```
Tokens:
Raw