@onboardbase/kit

Overview

Start Kit is a CLI tool for generating boilerplates with Onboardbase preconfigured as a SecretOps infrastructure.

Installation

Installing with npm

npm i -g @onboardbase/kit

Installing with Go:

go install github.com/Onboardbase/startkit@latest

Installing with Brew:

brew tap onboardbase/startkit

brew install startkit

Usage

Run to see all the commands available

startkit help

This will display information about the CLI.

> startkit help

CLI tool for generating boilerplates projects with Onboardbase completely setup.

Usage:
  startkit [command]

Aliases:
  startkit, obb

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  init        Initialize a new project

Flags:
  -g, --from-git string   Initialize a project from a git repository
  -h, --help              help for startkit
  -v, --version           version for startkit

Use "startkit [command] --help" for more information about a command.

To get more information about a command, run the command with -h, for example:

startkit init -h

We also have artifacts for different system architectures here

Initializing a Project

Run the init command:

startkit init

After providing the project name, you can select a project type:

Note: You must have the build tools needed to create the project you selected. For example, if you selected a project type based on NodeJS e.g. NestJs, Next.js, you must have Node.js already installed on your computer

After selecting a project type, you will be prompted to complete the flow for creating a project:

Initializing a Project From Git Repository

Note: You must have git installed and configured on your machine to do this

startkit can also automatically set up a project directly from a GitHub repo. It will attempt to clone the repository and then configure Onboardbase inside it. This means you must have permission to clone the repository if it's private.

To initialize from a git repository run

startkit init --from-git [git-repository]

e.g

startkit init --from-git https://github.com/Onboardbase/Flask-Starterkit.git

Contributing

Local Setup

Clone this repo and run go mod. You can then start the application with go run main.go

Adding More Project Types

Support for other frameworks is welcome. The easiest way to add new project-type support is to extend our git integration.

If you want a new project type and there is a popular, open-source community-vested boilerplate repository for that project type, you can make a PR to include that. The kit/flask.go is a reference for how to do just that.

You will then need to add the project type to the project_types/types const, and this is the current list we have:

const (
	Nestjs  = "NestJS"
	Nextjs  = "NextJS"
	Reactjs = "React.js"
	Vuejs   = "VueJs"
	Flask   = "Flask"
)

Afterward, you will need to include the new project type inside of kit/init.go:

func collectProjectType() string {
    ...
	items := []string {
		project_types.Nestjs,
		project_types.Nextjs,
		project_types.Reactjs,
		project_types.Vuejs,
		project_types.Flask,
	}
    ...
}

We have a simple sequence diagram for the project here docs/images/OBB_Kit_flow.png