Install from the GitHub repository. Inštalácia z GitHub repozitára.

Clone the source, pick what you want to change, and deploy your own build. Works the same whether you run locally or on a server. Naklonuj zdroj, zmeň čo chceš a nasaď vlastný build. Funguje rovnako lokálne aj na serveri.

[ 4.1 ]Clone the repositoryNaklonuj repozitár

git clone <repo-url> flowspace
cd flowspace
git checkout main

If you plan to contribute back, fork the repo on GitHub first, then clone your fork and add the original as upstream: Ak plánuješ prispievať, najprv si projekt forkni na GitHube, potom naklonuj svoj fork a pridaj originál ako upstream:

git clone git@github.com:<your-user>/flowspace.git
cd flowspace
git remote add upstream <original-repo-url>
git fetch upstream

[ 4.2 ]Pick your pathVyber si cestu

[ 4.3 ]What to change in the sourceČo v zdroji meniť

For a private deployment or a thesis/course fork, these are the typical places you touch. Pri privátnom nasadení alebo pri forku pre predmet/prácu najčastejšie meníš tieto miesta.

[ 4.4 ]Step-by-stepKrok za krokom

1. STEP 01

   Fork & cloneFork a klonuj

   Click Fork on GitHub, then clone your fork to your machine or server.Na GitHube klikni Fork, potom naklonuj svoj fork lokálne alebo na server.

2. STEP 02

   Create a working branchVytvor pracovnú vetvu

   Keep main clean. Work in short, named branches.Nechaj main čistý. Pracuj v krátkych pomenovaných vetvách.

   git checkout -b feat/my-change

3. STEP 03

   Set environmentNastav environment

   Copy the example and fill in real values. Generate a long SECRET_KEY.Skopíruj vzor a vyplň reálne hodnoty. Vygeneruj si dlhý SECRET_KEY.

   cp .env.example .env
   python -c "import secrets; print(secrets.token_urlsafe(48))"

4. STEP 04

   Run itSpusti

   Pick Docker or local. Minimal Docker run:Vyber Docker alebo lokál. Minimálny Docker beh:

   docker compose up -d --build
   docker compose logs -f api

5. STEP 05

   Stay in sync with upstreamUdržuj sync s upstreamom

   Pull upstream regularly so your fork keeps getting fixes.Pravidelne sťahuj upstream, aby tvoj fork dostával opravy.

   git fetch upstream
   git checkout main
   git merge upstream/main
   git push origin main

6. STEP 06

   Deploy your buildNasaď svoj build

   On the server: git pull, docker compose up -d --build. Alembic runs on startup when RUN_MIGRATIONS=true.Na serveri: git pull, docker compose up -d --build. Alembic sa spúšťa pri štarte, ak je RUN_MIGRATIONS=true.

[ 4.5 ]Updating laterAktualizácie neskôr

# on the machine running FlowSpace
cd flowspace
git pull
docker compose pull   # only if using pre-built image
docker compose up -d --build
docker compose exec api alembic -c backend/alembic.ini upgrade head

[ 4.6 ]Security checklistBezpečnostný checklist

• Strong random SECRET_KEY in production, different from dev.Silný náhodný SECRET_KEY v produkcii, iný než v dev.
• HTTPS via reverse proxy only — do not expose HTTP in public.HTTPS len cez reverznú proxy — nevystavuj HTTP verejne.
• Restrict CORS_ORIGINS to your real domains.Obmedz CORS_ORIGINS len na svoje reálne domény.
• Rotate DB passwords, never default admin/admin in production.Rotuj DB heslá, v produkcii nikdy nenechávaj admin/admin.
• Back up the postgres_data volume regularly.Pravidelne zálohuj volume postgres_data.