go-scaffold

README

go-scaffold

Tool to create project scaffold and provides some boilerplate in case of using gin, fiber or net/http

Install

To install, use go install

go install github.com/fedevilensky/go-scaffold@latest

Usage

go-scaffold h or go-scaffold help to display the help message.

go-scaffold <folder-name> to create a new module in a new folder named <folder-name>, or just go-scaffold to create project in pwd.

Use arrows (or j and k) to navigate, space to select, q to quit and enter to continue. When a text prompt is present you can still quit with Ctrl+c

Every file and folder will be created at the end, so feel free to quit and start over

Known problems

Will panic if go mod already exists

---

Logo created with Gopher Konstructor, based on Renee French's design

Documentation

Overview

go-scaffold is an opinionated scaffolding tool. It is intended for internal use at AboveSoftware, but shared as OSS for anyone to use or modify freely.

If there is go.mod file present in the desired folder, go-scaffold will fail. This is a tool for creating a project, not for modifying existing ones.

Usage:

• go-scaffold [folder]

If no folder is passed to go-scaffold, the project will be created on pwd.

If a folder is passed to go-scaffold, the project will be created on such folder.

If the folder passed is "help", no project will be created, a help message will be shown instead. If you want to create a project in a help folder, first create the folder, cd to it, and then run "go-scaffold" with no arguments.

This tool will ask for some basic options, for example:

• Web library
• DB library
• DBMS
• etc

You can cancel the execution at any time before the final stage of accepting the configuration, and nothing will be created