Skip to main content

Install SkillFlaw

SkillFlaw now provides two formal backend runtimes:

  • Python backend runtime
  • TypeScript backend runtime

This page is the shared entrypoint that helps you choose the correct installation guide.

Choose your runtime​

Python backend runtime​

Choose the Python guide when you want to use:

  • docker/docker-compose-py.yml
  • make init / make init_db
  • make backend
  • make run_cli / make run_clic

Go to: Install SkillFlaw - Python

TypeScript backend runtime​

Choose the TypeScript guide when you want to use:

  • docker/docker-compose-ts.yml
  • make ts_install_backend / make ts_init_db
  • make ts_backend
  • make ts_backend_verify
  • make ts_lfx_build / make ts_lfx_test
  • make ts_tool_build / make ts_tool_test

Go to: Install SkillFlaw - TypeScript

Quick comparison​

RuntimeDocker ComposeSource-install entrypointsDefault frontendDefault backend healthBest fit
Pythondocker/docker-compose-py.ymlmake init, make init_db, make backendhttp://localhost:3001 (Docker) / http://localhost:3000 (source)http://localhost:7860/healthPython backend development and current release-style local validation
TypeScriptdocker/docker-compose-ts.ymlmake ts_install_backend, make ts_init_db, make ts_backendhttp://localhost:3003 (Docker) / http://localhost:3000 (source)http://localhost:7861/health (Docker) / http://localhost:7860/health (source)TypeScript backend development and package-level validation

Repository clone​

Before using either installation path, clone the repository locally:


_10
git clone https://github.com/cwinux/skillflaw.git
_10
cd skillflaw

Install with Docker Compose​

Use Docker Compose when you want a complete local product stack.

Install from source​

Use source installation when you want repository-based development, debugging, or customization.

Docs service​

The documentation service remains shared across both runtimes.

Useful commands from the repository root:

  • make docs_dev
  • make docs_build
  • make docs_serve
  • make docs_start_only

For the full standalone docs deployment workflow, see Build and serve the documentation site.

Default admin account​

The default admin account prepared by repository initialization is:

  • username: admin
  • password: Skillflaw@123321