Skip to content

Repository files navigation

MiroVibe – Run Guide (English)

Use these steps to start both backend (Python) and frontend (TypeScript) locally.

Prerequisites

  • Git, Python 3.10+ with pip available.
  • Node.js 18+ and npm.
  • Optional but recommended: create a Python virtual environment.

Steps (from git pull to running)

  1. Get the latest code:
git pull
  1. Enter the project root:
cd miro-vibe
  1. Install npm dependencies (runs frontend install via postinstall):
npm install
  1. Install Python dependency for realtime (once):
python3 -m pip install websockets
  1. Start backend and frontend together (default: API on http://0.0.0.0:8000, WebSocket on ws://0.0.0.0:8765, frontend dev server on http://127.0.0.1:5173):
npm start
  1. Open the frontend in a browser at http://127.0.0.1:5173/. Use Register to create a user, then Log in.

Optional: run separately

  • Backend only:
    npm run start:backend
  • Frontend only (expects backend already running):
    npm run start:frontend

MiroVibe – Инструкция по запуску (Russian)

Ниже пошагово, как поднять бэкенд и фронтенд локально.

Требования

  • Git, Python 3.10+ с pip.
  • Node.js 18+ и npm.
  • По желанию: виртуальное окружение Python.

Шаги (от git pull до старта)

  1. Забрать свежий код:
git pull
  1. Перейти в корень проекта:
cd miro-vibe
  1. Установить npm-зависимости (postinstall поставит фронтенд):
npm install
  1. Поставить Python-зависимость для realtime один раз:
python3 -m pip install websockets
  1. Запустить бэкенд и фронтенд вместе (по умолчанию API http://0.0.0.0:8000, WebSocket ws://0.0.0.0:8765, фронт http://127.0.0.1:5173):
npm start
  1. Открыть http://127.0.0.1:5173/ в браузере. Зарегистрироваться, затем войти.

Опционально: раздельный запуск

  • Только бэкенд:
    npm run start:backend
  • Только фронтенд (нужен запущенный бэкенд):
    npm run start:frontend

About

vibe coding course project

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages