FlowSpace Docs
[ 02 ] LOCAL INSTALL LOKÁLNA INŠTALÁCIA

Run it on your machine. Spusti na svojom stroji.

Short, complete guide to install FlowSpace locally from zero — backend, database and frontend — without Docker. Krátky a úplný návod ako nainštalovať FlowSpace lokálne od nuly — backend, databáza a frontend — bez Dockeru.

[ 2.1 ]PrerequisitesPredpoklady

Install these once on your operating system. Exact install links are in brackets. Nainštaluj ich raz na svoj operačný systém. Odkazy na inštaláciu sú v zátvorkách.

On macOS use brew install python@3.13 node@22 postgresql@17 git. On Ubuntu use apt. On Windows use the official installers or winget. Na macOS použi brew install python@3.13 node@22 postgresql@17 git. Na Ubuntu použi apt. Na Windows použi oficiálne inštalátory alebo winget.

[ 2.2 ]Step-by-stepKrok za krokom

  1. STEP 01

    Get the codeStiahni kód

    Clone the repository and enter the project directory.Naklonuj repozitár a vstúp do projektového adresára.

    git clone <repo-url> flowspace
    cd flowspace
  2. STEP 02

    Create a PostgreSQL databaseVytvor PostgreSQL databázu

    Start your local PostgreSQL server, then create user and database. Names must match what you put in .env.Spusti lokálny PostgreSQL server, potom vytvor používateľa a databázu. Mená musia sedieť s tým, čo dáš do .env.

    CREATE USER admin WITH PASSWORD 'admin';
    CREATE DATABASE flowspace OWNER admin;
    GRANT ALL PRIVILEGES ON DATABASE flowspace TO admin;
  3. STEP 03

    Configure environmentNastav environment

    Copy the example file and open .env. For local run set DB_URL host to localhost.Skopíruj vzorový súbor a otvor .env. Pre lokálny beh nastav v DB_URL host na localhost.

    cp .env.example .env
    DB_URL=postgresql+psycopg://admin:admin@localhost:5432/flowspace
    SECRET_KEY=replace_with_a_long_random_secret
    BACKEND_HOST=127.0.0.1
    BACKEND_PORT=8000
    CORS_ORIGINS=http://localhost:5173,http://127.0.0.1:5173
  4. STEP 04

    Backend — Python env & depsBackend — Python prostredie a závislosti

    Create and activate a virtualenv, then install dependencies.Vytvor a aktivuj virtuálne prostredie, potom nainštaluj závislosti.

    python3.13 -m venv .venv
    source .venv/bin/activate
    pip install -r requirements.txt
    On Windows PowerShell use .venv\Scripts\Activate.ps1. Na Windows PowerShell použi .venv\Scripts\Activate.ps1.
  5. STEP 05

    Apply database migrationsAplikuj migrácie databázy

    Create tables and seed initial content with Alembic.Vytvor tabuľky a nasej počiatočný obsah cez Alembic.

    alembic -c backend/alembic.ini upgrade head
  6. STEP 06

    Run the backendSpusti backend

    This starts FastAPI on port 8000. Swagger UI lives at /docs.Toto spustí FastAPI na porte 8000. Swagger UI je na /docs.

    python -m backend.run

    Visit http://localhost:8000/docs to check that the API is up. Over na http://localhost:8000/docs, že API beží.

  7. STEP 07

    Frontend — install & runFrontend — inštalácia a beh

    In a second terminal, install frontend deps and start the Vite dev server.V druhom termináli nainštaluj frontend závislosti a spusti Vite dev server.

    cd frontend
    npm install
    cp .env.example .env.local
    npm run dev
  8. STEP 08

    Open the appOtvor aplikáciu

    Frontend: http://localhost:5173. You should see the landing page, be able to register and log in. Frontend: http://localhost:5173. Mala by sa zobraziť úvodná stránka, mal by si sa vedieť zaregistrovať a prihlásiť.

[ 2.3 ]Everyday commandsBežné príkazy

TaskÚloha CommandPríkaz
Activate venvAktivuj venvsource .venv/bin/activate
Run backendSpusti backendpython -m backend.run
Run frontendSpusti frontendcd frontend && npm run dev
Apply migrationsAplikuj migráciealembic -c backend/alembic.ini upgrade head
Create migrationVytvor migráciualembic -c backend/alembic.ini revision --autogenerate -m "msg"
Run testsSpusti testypytest -q test/backend

[ 2.4 ]If something goes wrongAk sa niečo pokazí

  • Port in use — change BACKEND_PORT in .env or stop the process using it.Port je obsadený — zmeň BACKEND_PORT v .env alebo ukonči proces, ktorý ho drží.
  • Cannot connect to database — verify PostgreSQL is running and DB_URL matches the created user/db.Nepripája sa k DB — over, že PostgreSQL beží a DB_URL sedí s vytvoreným používateľom/databázou.
  • CORS error in browser — add your frontend URL into CORS_ORIGINS.CORS chyba v prehliadači — pridaj URL frontendu do CORS_ORIGINS.
  • Schema errors on start — run alembic upgrade head again.Chyby schémy pri štarte — spusti znova alembic upgrade head.
Prefer containers? Continue with Docker — one command and you are up. Chceš kontajnery? Pokračuj v Dockeri — jeden príkaz a bežíš.