Getting Started

Quick start guide and basic concepts

Installation

npm install -g @boomscaf/cli

Command: boom init

Scaffold a full-stack app with backend and (optional) frontend integration.

PromptOptionsDescription
API Typegraphql, restType of API to scaffold
ORMknex, sequelizeDatabase ORM
API Libraryapollo-server, ExpressAPI server library for GraphQL
Frontend Hooksno, react, solidGenerates frontend hooks and components for UI layer

Usage

boom

Run the CLI and follow the interactive prompts:

  • API Type: graphql or rest
  • ORM: knex, sequelize
  • API Library: e.g. apollo-server for GraphQL or Express
  • Frontend Hooks and Components: Choose a frontend framework (or none)

Example

$ boom ? Which API Type? › graphql ? Which ORM would you like to use? › sequelize ? Which API uiLibrary? › apollo-server ? Include Frontend hooks? › react

The generator will create a complete backend (and optional frontend) project in the build/ folder.