Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
84 lines (61 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

84 lines (61 loc) · 1.63 KB

Contributing

Overview

fba-cli is the CLI for fastapi-best-architecture. This document collects development, usage, and command details that are intentionally kept out of the main README files.

Prerequisites

Develop From Source

git clone https://github.com/fastapi-practices/fba-cli.git
cd fba-cli

Install dependencies with either package manager:

pnpm install
bun install

Run the CLI in development:

pnpm dev
bun run dev

Command Overview

  • create: create a new project, default command
  • dev: start backend dev server
  • dev:web: start frontend dev server
  • dev:celery <worker|beat|flower>: start Celery services
  • plugin add|remove|create|list: plugin management
  • list|current|use|remove|edit|go: project management
  • infra start|stop: infrastructure management
  • config set: update global config

Global Options

-p, --project <dir>   Specify project directory (defaults to current project)
--lang <lang>         Switch language (zh/en)
-h, --help            Show help
-v, --version         Show version

Configuration Files

  • Global config: ~/.fba.json
  • Project config: <project>/.fba.json

Development Scripts

Use pnpm:

pnpm dev
pnpm typecheck
pnpm build

Use bun:

bun run dev
bun run typecheck
bun run build