Awesome
Go Blueprint is a CLI tool that allows users to spin up a Go project with the corresponding structure seamlessly. It also gives the option to integrate with one of the more popular Go frameworks (and the list is growing with new features)!
Why Would I use this?
- Easy to set up and install
- Have the entire Go structure already established
- Setting up a Go HTTP server (or Fasthttp with Fiber)
- Integrate with a popular frameworks
- Focus on the actual code of your application
Table of Contents
- Install
- Frameworks Supported
- Database Support
- Advanced Features
- Blueprint UI
- Usage Example
- GitHub Stats
- License
<a id="install"></a>
<h2> <picture> <img src="./public/install.gif?raw=true" width="60px" style="margin-right: 1px;"> </picture> Install </h2>go install github.com/melkeydev/go-blueprint@latest
This installs a go binary that will automatically bind to your $GOPATH
Then in a new terminal run:
go-blueprint create
You can also use the provided flags to set up a project without interacting with the UI.
go-blueprint create --name my-project --framework gin --driver postgres --git commit
See go-blueprint create -h
for all the options and shorthands.
<a id="frameworks-supported"></a>
<h2> <picture> <img src="./public/frameworks.gif?raw=true" width="60px" style="margin-right: 1px;"> </picture> Frameworks Supported </h2><a id="database-support"></a>
<h2> <picture> <img src="./public/database.gif?raw=true" width="45px" style="margin-right: 15px;"> </picture> Database Support </h2>Go Blueprint now offers enhanced database support, allowing you to choose your preferred database driver during project setup. Use the --driver
or -d
flag to specify the database driver you want to integrate into your project.
Supported Database Drivers
Choose from a variety of supported database drivers:
<a id="advanced-features"></a>
<h2> <picture> <img src="./public/advanced.gif?raw=true" width="70px" style="margin-right: 1px;"> </picture> Advanced Features </h2>Blueprint is focused on being as minimalistic as possible. That being said, we wanted to offer the ability to add other features people may want without bloating the overall experience.
You can now use the --advanced
flag when running the create
command to get access to the following features. This is a multi-option prompt; one or more features can be used at the same time:
- HTMX support using Templ
- CI/CD workflow setup using Github Actions
- Websocket sets up a websocket endpoint
- Tailwind css framework
Note: selecting tailwind option automatically selects htmx.
<a id="blueprint-ui"></a>
<h2> <picture> <img src="./public/ui.gif?raw=true" width="100px" style="margin-right: 1px;"> </picture> Blueprint UI </h2>Blueprint UI is a web application that allows you to create commands for the CLI and preview the structure of your project. You will be able to see directories and files that will be created upon command execution. Check it out at go-blueprint.dev
<a id="usage-example"></a>
<h2> <picture> <img src="./public/example.gif?raw=true" width="60px" style="margin-right: 1px;"> </picture> Usage Example </h2>Here's an example of setting up a project with a specific database driver:
go-blueprint create --name my-project --framework gin --driver postgres --git commit
<p align="center">
<img src="./public/blueprint_1.png" alt="Starter Image" width="800"/>
</p>
Advanced features are accessible with the --advanced flag
go-blueprint create --advanced
Advanced features can be enabled using the --feature
flag along with the --advanced
flag.
HTMX:
go-blueprint create --advanced --feature htmx
CI/CD workflow:
go-blueprint create --advanced --feature githubaction
Websocket:
go-blueprint create --advanced --feature websocket
Tailwind:
go-blueprint create --advanced --feature tailwind
Or all features at once:
go-blueprint create --name my-project --framework chi --driver mysql --advanced --feature htmx --feature githubaction --feature websocket --feature tailwind --git commit
<p align="center">
<img src="./public/blueprint_advanced.png" alt="Advanced Options" width="800"/>
</p>
Visit documentation to learn more about blueprint and its features.
<a id="github-stats"></a>
<h2> <picture> <img src="./public/stats.gif?raw=true" width="45px" style="margin-right: 10px;"> </picture> Github Stats </h2> <p align="center"> <img alt="Alt" src="https://repobeats.axiom.co/api/embed/7c4be18864d441f961be61186ce49b5471a9e7bf.svg" title="Repobeats analytics image"/> </p><a id="license"></a>
<h2> <picture> <img src="./public/license.gif?raw=true" width="50px" style="margin-right: 1px;"> </picture> License </h2>Licensed under MIT License