Skip to content

Installing flow8 from source

Api installation

Prerequisites:

Before starting, ensure the following requirements are met:

  • Go installed and Go environment variables is configured:

Make sure you have Go installed on your system. You can download it from Go installation.

wget https://go.dev/dl/go{{go_version}}.linux-amd64.tar.gz
rm -rf /usr/local/go && tar -C /usr/local -xzf go{{go_version}}.linux-amd64.tar.gz
export PATH=$PATH:/usr/local/go/bin

Verify installation by running:

go version

It should display the installed version of Go.

  • Git Installed:

Ensure git is installed. Verify with:

git --version

Installation Steps:

Clone the Repository

Clone the source code of flow8 from its repository using Git.

git clone https://git.qix.sx/adentro/flow8.git

Navigate into the project directory:

cd flow8
Create a .env File with environment variables.

Read more about in Environment variables section

Install packages
go mod tidy
Build the Application

Run the go build command to compile the source code. This generates an executable binary:

go build -o server server.go

By default, the binary will be named server (or server.exe on Windows).

Run the Application

To verify the installation, run the application:

./server

App installation

Prerequisites:

Before starting, ensure the following requirements are met:

You can check it with:

node -v
  • Npm is installed.

You can check it with:

npm -v
  • Git Installed:

Ensure git is installed. Verify with:

git --version

Installation steps:

Get source code

Clone repository:

git clone https://git.qix.sx/adentro/flow8-ui.git

And navigate to app folder:

cd flow8-ui
Define environment variables in .env file

Read more about in Environment variables section

Install dependencies
npm install
Run application

For development:

npm run dev

For production:

npm run build

Static files distenation is ./dist directory, replace it to webserver root directory

Nginx configuration as example:

server {
listen 80;
listen [::]:80;
server_name localhost;
location / {
root /usr/share/nginx/html;
index index.html index.htm;
try_files $uri /index.html;
}
error_page 500 502 503 504 /50x.html;
location = /50x.html {
root /usr/share/nginx/html;
}
}

Troubleshooting