v1.0.0
Home / Docs

Installation

Horilla is a remarkable open-source web application that has been built using the versatile Python framework, Django. Being compatible with all operating systems that support Python, this application can be easily installed on any platform.

If you wish to enjoy its remarkable features and benefits, follow these simple steps to install the application on your preferred platform.

Windows

Django is a high-level Python web framework that enables rapid development of secure and scalable web applications. It is a popular choice among web developers due to its scalability, flexibility, and its ease of use. 

Prerequisites:

Before installing Django, you need to ensure that you have the following software installed on your Windows system:

If you don’t have Python installed, you can download and install it from the official Python website (https://www.python.org/downloads/). After installing Python, you can install pip by running the following command in your command prompt:

python -m ensurepip --default-pip

Installing Django:

Once you have Python and pip installed, you can proceed with installing Django. There are different ways to install Django, but the easiest way is to use pip. You can install Django using pip by following these steps:

pip install Django

After installing Django, you need to verify that it is correctly installed. You can do this by running the following command in your command prompt.

django-admin --version

If Django is installed correctly, the version number will be displayed in your command prompt correctly.

Installing Horilla:

Horilla is an open-source web application built using the Django framework. In order to install Horilla, you first need to have Python and Django installed on your system. Additionally, you should also have Git installed on your system to clone the Horilla repository.

Follow the steps below to install Horilla:

Open your command prompt and navigate to the directory where you want to clone the Horilla repository. Once you are in the desired directory, run the following command:

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

This will clone the Horilla repository to your system.

Navigate to the Horilla directory using the following command:

cd horilla

Once you are inside the Horilla project directory, install the required Python packages using the following command:

pip install -r requirements.txt

This command will install all the necessary Python packages required by the Horilla application.

Now that you have installed the required packages, it’s time to set up the database. Run the following commands to create the necessary tables:

python manage.py makemigrations
python manage.py migrate
python manage.py compilemessages

This will create the required tables in your database.

Next, you need to create an admin user for the Horilla application. Run the following command to create an admin user:

python manage.py createhorillauser

Follow the prompts to enter the details for the admin user.

Now that you have completed all the necessary steps, you can run the Horilla application. To start the Horilla application, run the following command: 

python manage.py runserver

This will start the Horilla application on your local server. You can access the application by opening your web browser and navigating to http://localhost:8000/. 

Congratulations! You have successfully installed and set up Horilla on your system.

 

Ubuntu

Before you install any new software on your Ubuntu system, it’s always a good idea to update your system first. Open your terminal and run the following commands:

sudo apt update
sudo apt upgrade

This will update and upgrade your system.

Django is built using Python, so you need to have Python and Pip installed on your system. Run the following command to install Python and Pip:

sudo apt install python3 python3-pip

This will install Python and Pip in your system

Now that you have installed Python and Pip, you can use Pip to install Django. Run the following command.

sudo pip3 install django

This will install the latest version of Django on your system.

To verify that Django has been installed correctly run the following command.

django-admin --version

Open your terminal and navigate to the directory where you want to clone the Horilla repository. Once you are in the desired directory, run the following command:

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

This will clone the Horilla repository to your system.

Navigate to the Horilla directory using the following command:

cd horilla

Once you are inside the Horilla project directory, install the required Python packages using the following command:

pip install -r requirements.txt

This command will install all the necessary Python packages required by the Horilla application.

Now that you have installed the required packages, it’s time to set up the database. Run the following commands to create the necessary tables:

python3 manage.py makemigrations
python3 manage.py migrate
python3 manage.py compilemessages

This will create the required tables in your database.

Next, you need to create an admin user for the Horilla application. Run the following command to create an admin user:

python3 manage.py createhorillauser

This will create the required tables in your database.

Follow the prompts to enter the details for the admin user.

Now that you have completed all the necessary steps, you can run the Horilla application. To start the Horilla application, run the following command:

python3 manage.py runserver

This will start the Horilla application on your local server. You can access the application by opening your web browser and navigating to http://localhost:8000/. 

Congratulations! You have successfully installed and set up Horilla on your system.

 

By default an SQLite3 database will be created. If you wish to change the database to any other, use this reference.

macOS

Before installing Django and Horilla in your system, make sure that you have python installed on your system.

You can download the latest version of Python from the official website : 

https://www.python.org/downloads/macos/

After python is installed, lets proceed with the installation of Django.

Use the Pip command to install Django to your system. Open the terminal and run the following command.

pip install Django

This will install the latest version of python of Django to your macOS system.

After the installation is complete, you can verify the installation using the command in your terminal

django-admin --version

This shows the version number of Django installed, if its installed successfully.

Open your terminal and navigate to the directory where you want to clone the Horilla repository. Once you are in the desired directory, run the following command:

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

 

This will clone the Horilla repository to your system.

Navigate to the Horilla directory using the following command:

cd horilla

Once you are inside the Horilla project directory, install the required Python packages using the following command:

pip install -r requirements.txt

This command will install all the necessary Python packages required by the Horilla application.

Now that you have installed the required packages, it’s time to set up the database. Run the following commands to create the necessary tables:

python3 manage.py makemigrations
python3 manage.py migrate
python3 manage.py compilemessages

This will create the required tables in your database.

python3 manage.py createhorillauser

Follow the prompts to enter the details for the admin user.

Now that you have completed all the necessary steps, you can run the Horilla application. To start the Horilla application, run the following command:

python3 manage.py runserver

 

This will start the Horilla application on your local server. You can access the application by opening your web browser and navigating to http://localhost:8000/. 

Congratulations! You have successfully installed and set up Horilla on your system.