1.1.2 โ€ข Published 11 months ago

@boomscaf/cli v1.1.2

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

โšก BOOM!Scaffold โ€” Fullstack in Seconds

BOOM!Scaffold is a schema-first scaffolding engine that turns your data model into a fully-typed, production-grade TypeScript stack in seconds โ€” backend, frontend, and infra.

Ideal for solo founders, internal tools, MVPs, and anyone who wants to skip the boilerplate and ship faster.

๐ŸŽฏ Playground

https://www.boomscaffold.com/playground/


๐Ÿš€ What It Does

From a single config file + your schema, BOOM!Scaffold generates:

  • A full API โ€” either GraphQL or REST (Express)
  • A backend powered by either Knex or Sequelize
  • A modern frontend (hooks, UI config, Tailwind)
  • End-to-end typing + data services
  • Optional admin panel, CI/CD, infra (AWS/CDK)

All in under 60 seconds.


๐Ÿงช Quickstart

Install (coming soon via npm):

npm i @boomscaf/cli

Or, if youโ€™re cloning locally:

git clone https://github.com/calebswank11/boom-cli-core.git
cd boom-cli-core
yarn && yarn dev

Run the Scaffold (CLI):

Ensure you have a SQL schema in ./sqlInput/ and a scaffold.config.json at the root.

Then generate your fullstack scaffold:

boom init

Youโ€™ll see:

   ___   ___ __
  / _ ) / // __)
 / _ < /_/\__\
/____/(_)(___/

BOOM!Scaffold

Example Input

SQL Schema: ./sqlInput/example.sql

CREATE TABLE user (
  id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
  email VARCHAR(255) UNIQUE NOT NULL,
  password TEXT NOT NULL,
  role ENUM('admin', 'user') DEFAULT 'user'
);

Scaffold Config: scaffold.config.json

{
  "project": "my-app",
  "inputRoot": "./sqlInput",
  "orm": "knex",            // or "sequelize"
  "apiType": "graphql",     // or "express"
  "library": "apollo-server",
  "database": {
    "client": "pg",
    "connection": "..."
  },
  "outputs": {
    "api": true,
    "frontend": true,
    "adminPortal": false
  },
  "frontEnd": {
    "framework": "react",
    "ui": "tailwind"
  },
  "deployment": {
    "ci": "github-actions",
    "infra": "aws-cdk"
  }
}

๐Ÿ“ฆ Output Structure

Your scaffold adapts to your stack. Whether you choose Knex + GraphQL, Sequelize + REST, or any combo, you'll get a clean, structured project:

Backend:

build/
โ”œโ”€โ”€ enums/           # Auto-generated enums
โ”œโ”€โ”€ migrations/      # Migration files (Knex or Sequelize)
โ”œโ”€โ”€ seeds/           # Seed data
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ @types/      # Global TS types
โ”‚   โ”œโ”€โ”€ config/      # DB/API config
โ”‚   โ”œโ”€โ”€ database/    # Connection logic
โ”‚   โ”œโ”€โ”€ dataServices/# CRUD helpers (Knex or Sequelize)
โ”‚   โ”œโ”€โ”€ ?resolvers/  # GraphQL resolvers (if selected)
โ”‚   โ”œโ”€โ”€ ?controllers/# REST controllers (if selected)
โ”‚   โ”œโ”€โ”€ ?models/     # REST models (if selected)
โ”‚   โ”œโ”€โ”€ ?routes/     # Express routes (if selected)
โ”‚   โ”œโ”€โ”€ ?typedefs/   # GraphQL typeDefs
โ”‚   โ””โ”€โ”€ utils/       # Misc helpers
โ”œโ”€โ”€ app/             # Optional frontend
โ”œโ”€โ”€ cicd/            # GitHub Actions
โ”œโ”€โ”€ cloudOps/        # AWS/CDK infra
โ””โ”€โ”€ index.ts         # CLI entry

Frontend (if enabled):

app/
โ”œโ”€โ”€ api/             # Query/mutation clients or REST calls
โ”œโ”€โ”€ config/ui/       # Tailwind UI config
โ”œโ”€โ”€ hooks/           # Auto-generated React/Solid/Svelte/Vue hooks
โ”œโ”€โ”€ store/           # Global state
โ””โ”€โ”€ pages/           # Optional routing structure

Next Up:

cd build && yarn && yarn dev

Add your DB secrets, build business logic, and launch ๐Ÿ’ฅ


๐Ÿ”ง Features

  • ๐Ÿง  Schema-based generation โ€” just define your DB schema
  • ๐Ÿ” Knex or Sequelize โ€” choose your preferred SQL ORM
  • ๐Ÿ”€ GraphQL or REST โ€” pick your API type, or scaffold both
  • ๐Ÿงฌ Typed everything โ€” from services to typedefs
  • ๐ŸŽจ Tailwind UI + hooks โ€” generated from your schema

๐Ÿ›  Developer Workflow

  1. Create your schema (SQL or DSL)
  2. Configure scaffold.config.json
  3. Run the CLI:

    npx @boomscaf/cli@ init
  4. Update config as needed

  5. Re-run the scaffold:

    npx @boomscaf/cli generate
  6. Build on top. Done.


๐Ÿ“Œ Use Cases

  • ๐Ÿง‘โ€๐Ÿ’ป Solo devs building MVPs
  • ๐Ÿข Internal tooling
  • ๐Ÿงฌ Data-first product backends
  • ๐Ÿ›’ Marketplaces
  • โš™๏ธ Reusable scaffolds across teams

๐Ÿšง Roadmap

FeaturePurpose
๐Ÿ”„ Inline rescaffoldingDetect schema changes and update files non-destructively
๐Ÿ” JWT auth, rate limiting, versioningAdd production-ready security out of the box
๐Ÿง  Ollama integrationNatural-language prompts to generate scaffold features
๐Ÿงฑ Admin CRUD dashboardsAuto-generate admin panels tied to schema
๐Ÿงฎ AI DB DesignerVisual schema builder with config export
๐Ÿ’ป Toggleable test outputOptional test file scaffolding with Jest or other libs
โ˜๏ธ AWS CDK / Terraform / PulumiScaffold infrastructure as code
๐Ÿ”„ CI/CD + Docker + GitHub ActionsGenerate deployment and container setup
๐Ÿ“˜ Auto-generated API docsCreate OpenAPI or GraphQL schema docs automatically
๐Ÿงญ Frontend route generatorAutomatically maps schema resources to frontend pages
๐Ÿงฐ Design system starterTailwind-based base components, forms, layouts
๐Ÿ’ซ Frontend animation presetsSmooth entry/exit transitions, especially for admin UIs
๐Ÿ” RBAC supportAdd field- and route-level access rules from config
๐Ÿ“ Modular plugin supportEventually allow community plugin generation
โœ๏ธ Schema linter + formatterValidate/enforce schema structure before scaffolding

๐Ÿ’ฌ Feedback

Weโ€™re building fast. Hit something weird? Want a new feature? Drop us a note or submit feedback here.

1.1.2

11 months ago

1.1.0

11 months ago

1.0.11

12 months ago

1.0.10

12 months ago

1.0.9

12 months ago

1.0.8

12 months ago

1.0.7

12 months ago

1.0.6

12 months ago

1.0.5

12 months ago

1.0.4

12 months ago

1.0.3

12 months ago

1.0.2

12 months ago

1.0.1

12 months ago

1.0.0

12 months ago