Skip to main content
Installation Guide

Install LowCodeJS

Follow these steps to get your platform running

Prerequisites

Before getting started, make sure you have the following software installed:

Docker

Containerization platform required to run the application.

Install Docker →

Docker Compose

Tool to orchestrate multiple Docker containers.

Install Docker Compose →

Disk Space

At least 10GB of free disk space required for Docker images and data.

1

Download the files

Download the necessary files from the official repository:

bash
$curl -O https://raw.githubusercontent.com/lowcodejsorg/lowcodejs/main/docker-compose.oficial.yml
$curl -O https://raw.githubusercontent.com/lowcodejsorg/lowcodejs/main/.env.example
$curl -O https://raw.githubusercontent.com/lowcodejsorg/lowcodejs/main/credential-generator.sh
$chmod +x credential-generator.sh
2

Create configuration file

Copy the example file to create your configuration file:

bash
$cp .env.example .env
3

Run the setup script

The script will generate JWT credentials and update the .env file automatically:

bash
$./credential-generator.sh
4

Review environment variables

Open the .env file and review the configuration variables. Adjust according to your environment: URLs (localhost, IP or domain), database credentials, email settings (optional for password recovery), among others.

5

Start the containers

Run the Docker Compose command to start all services:

bash
$docker compose -f docker-compose.oficial.yml up -d --build
6

Run initial seed

Execute the seed command to create the initial admin user:

bash
$docker exec lowcodejs-api node database/seeders/main.js

Access the application

Platform Ready!

Your LowCodeJS instance is up and running

Frontendhttp://localhost:5173
APIhttp://localhost:3000
Docshttp://localhost:3000/documentation

Next Steps