Skip to main content

Getting Started

FluidServer is an open-source POS-system server for humans, meant to be easy, intuitive and scalable.

Usage Example

Sending a request to /api/product/1 will return the product data in JSON

If you want to host in a port different than the default 1618, just run FluidServer with the argument --port or -p and your port. However, using ports below 1024 are not recommended as those ports are considered "privileged ports" and require root to use.

Installation

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/FluidServer/server/HEAD/install.sh)"

After that, make sure you add frun to your PATH:

And then add it to path:

fish_add_path -U 
warning

The command might be different depending on your OS and shell.

For Windows make sure to use C:\Program Files\FluidServer, and on Linux use /opt/fluidserver/frun.

Tada! FluidServer is now installed.

Setup

To setup FluidServer, just install a version and run it.

frun install 1.0 --setup

And to run it anywhere:

frun run 1.0

Use latest to install the latest version, such as: frun i latest

The setup will guide you to create user accounts, setup your server and everything you need to get setup, however, if you still need help, continue reading this section.

Todo: finish this section after finishing the setup 🤷