Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
87 lines (62 loc) · 1.33 KB

DEVELOPMENT.md

File metadata and controls

87 lines (62 loc) · 1.33 KB

Development Guide

This document covers local development workflow for start-it-cli.

Prerequisites

  • Node.js 18+ recommended
  • npm

Install

npm install

Build

npm run build

This compiles TypeScript from src/ into dist/.

Run Locally

Interactive mode:

npm run dev

Command-driven examples:

npm run dev -- my-app --stack react-vite --yes
npm run dev -- fire_extinguisher_ms --app-type backend --stack python-fastapi --path /tmp --yes

Test

npm test

The test suite validates generated project structure and generated guidance artifacts.

Common Workflow

  1. Update prompt, config, or generation logic.
  2. Run npm test.
  3. Run npm run build.
  4. Update user-facing docs if CLI behavior changed.

Where To Work

  • src/cli.ts
    • CLI parsing and prompts
  • src/workflow.ts
    • available app types and stacks
  • src/generator.ts
    • generation routing
  • src/templates/
    • backend builders and older static templates
  • src/frontend/
    • frontend scaffolders
  • src/aiml/
    • AI/ML scaffolders
  • src/dsa/
    • DSA scaffolders
  • src/agent/
    • AI guidance composition

Packaging Smoke Check

npm pack --dry-run

Docker Smoke Check

docker build -t start-it-cli:local .
docker run --rm start-it-cli:local --help