Empower Your HR with Next-Gen Open Source Self-Serve Platform

---

Installation

To install Libur.run, please follow the instructions provided below. Once you've installed and set up the platform, you'll be able to start managing your HR needs with ease. The following installation is manual, meaning you have responsibilty for the requirements. If you are using Docker, you can follow the installation with Docker.

Prerequisites

Before you install and start using Libur.run, please make sure your system meets the following requirements:

• Ruby version 3.1.2
• Node.js 16 or newer
• PostgreSQL 14 or newer
• Redis 6 or newer

Getting Ready

1. Give a star to support this project on GitHub :)
2. Before you start, make sure you have Ruby 3.1.2, PostgreSQL, and Redis installed on your machine.
3. Clone or download the Libur.run repository.
4. Start the PostgreSQL and Redis databases, and make note of the credentials for each database as you'll need to configure the application later.
5. Navigate to the application directory and copy the .env.example file to .env with cp .env.example .env.
6. Open the .env file and change the REDIS_URL to your local Redis database (usually redis://localhost:6379/1).
7. Update the DATABASE_* environment variables with the correct values for your PostgreSQL database.
8. Don't forget to set the SECRET_KEY_BASE, as it will be used for encryption.
9. Finally, install the dependencies by running bundle install and yarn install.

Database Setup

1. Open your terminal and navigate to the Libur.run application directory.
2. Create the application database by running the following command: rails db:create
3. Migrate the schema by running the following command: rails db:migrate. If any errors occur, double-check your database configuration in the application.
4. Populate some initial data before starting the application by running the following command: rails db:seed

Run the application

1. Open your terminal and run ./bin/dev to start the application.
2. Wait until all processes are complete.
3. Open your browser and access localhost:3000. You're now ready to start using Libur.run. Welcome!

With Docker

Installing Libur.run with Docker makes the process easy and smooth. To get started, make sure that Docker is installed on your machine and that Docker Compose V2 is enabled. You can find the Dockerfile and compose.yml files in the root directory of the Libur.run repository.

Here are the steps to install Libur.run with Docker:

1. Give a star to support this project on GitHub :)
2. Ensure that Docker is running on your machine, and open a terminal and navigate to the application directory.
3. Create .env file by running cp .env.example .env and then set the DATABASE_HOST to db and REDIS_URL to redis://redis:6379/1 in .env file.
4. Don't forget to set the SECRET_KEY_BASE, as it will be used for encryption.
5. Build the image by running docker compose build. Wait until the process is complete.
6. Start the application by running docker compose up or docker compose up -d to run the containers in the background (detached mode).
7. To set up the database, open a new terminal window (if you're not using detached mode) and run docker compose exec web bin/rails db:setup.
8. Once the database is set up, the application will be ready to use. Open your browser and access localhost:3000. Enjoy using Libur.run!

Setting up Account

Getting started with Libur.run is easy! Simply access the URL, if running locally, localhost:3000. On the installation page, you'll be guided through a few simple steps to set up your account. Just follow the prompts and you'll be ready to go in no time!

TODO: Add Installation Video

Features

The following features are disabled by default and can be enabled by following these instructions.

Setting up ActionMailer with SMTP Server

To send emails through the application, you can use an SMTP server. Our framework supports this feature and it can be easily enabled by adding some environment variables. You can add these variables to your system in the .env file.

Variable name	Default value
SMTP_ADDRESS
SMTP_AUTHENTICATION	:plain
SMTP_DOMAIN
SMTP_ENABLE_STARTTLS	true
SMTP_PASSWORD
SMTP_PORT	587
SMTP_USERNAME

Once you have set the environment variables, go to the config/environments directory and open the environment file you want to enable SMTP on. For example, if you want to enable SMTP on the production environment, edit the config/environments/production.rb file.

• Add the SMTP configuration at the top of the file by including require Rails.root.join("config/smtp").
• Change the delivery method to :smtp by using config.action_mailer.delivery_method = :smtp.
• Set the SMTP server you configured earlier by using config.action_mailer.smtp_settings = SMTP_SETTINGS.
• You may also need to update the default email for the mailer in app/mailers/application_mailer.rb.

With these steps, the application will use your SMTP server to send emails. Enjoy!

Deployment to Production

Work in progress

Contributing

If you're interested in contributing to Libur.run, please read our contributing docs before submitting a pull request.

License

Libur.run is open-source software licensed under the MIT License. This means you're free to use, modify, and distribute the software as you see fit, subject to certain conditions outlined in the license. For more details, please see the LICENSE file.