Installation
Local dev setup​
Step 1: Install docker & docker-compose​
- Ubuntu / Debian
- Fedora / RHEL / CentOS
- Arch Linux / Manjaro
- macOS
- Windows
Using apt
# Update packages
sudo apt update
# Install Docker
sudo apt install -y docker.io
# Enable & start Docker
sudo systemctl enable docker
sudo systemctl start docker
# Install Docker Compose
sudo apt install -y docker-compose
Using dnf or yay
# Install Docker
sudo dnf install -y docker
# Enable & start Docker
sudo systemctl enable docker
sudo systemctl start docker
# Install Docker Compose
sudo dnf install -y docker-compose
Using pacman
# Install Docker
sudo pacman -Syu docker
# Enable & start Docker
sudo systemctl enable docker
sudo systemctl start docker
# Install Docker Compose
sudo pacman -S docker-compose
Using homebrew
# Install Docker Desktop
# Docker Compose comes with it
brew install --cask docker
Using chocolatey
# Install Docker Desktop
# Docker Compose comes with it
choco install docker-desktop
Step 2: Clone the repository​
git clone https://github.com/Five-Stacks/area.git
Step 3: Launch the app​
docker-compose up
This will launch a couple of things :
- Backend server & database.
- Frontend web app, accessible on http://localhost:8081.
- Frontend mobile app, download on http://localhost:8082, QR code available to download it directly on your phone if it is on the same network as your pc running the app.
Local build​
There is actually no easy way to build a packaged app for web & mobile apps.
Server deployment​
There is actually no easy way to deploy the app on a server.
Kubernetes setup may be included at later date.