Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Melkeydev/go-blueprint
Go-blueprint allows users to spin up a quick Go project using a popular framework
https://github.com/Melkeydev/go-blueprint
Last synced: about 2 months ago
JSON representation
Go-blueprint allows users to spin up a quick Go project using a popular framework
- Host: GitHub
- URL: https://github.com/Melkeydev/go-blueprint
- Owner: Melkeydev
- License: mit
- Created: 2023-10-11T07:20:12.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-30T17:29:43.000Z (2 months ago)
- Last Synced: 2024-10-04T09:09:45.530Z (2 months ago)
- Language: Go
- Homepage: https://docs.go-blueprint.dev/
- Size: 7.93 MB
- Stars: 3,891
- Watchers: 27
- Forks: 247
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - go-blueprint - Allows users to spin up a quick Go project using a popular framework. (Miscellaneous / Project Layout)
- jimsghstars - Melkeydev/go-blueprint - Go-blueprint allows users to spin up a quick Go project using a popular framework (Go)
- awesome-go - go-blueprint - Allows users to spin up a quick Go project using a popular framework. Stars:`5.9K`. (Miscellaneous / Project Layout)
- awesome-repositories - Melkeydev/go-blueprint - Go-blueprint allows users to spin up a quick Go project using a popular framework (Go)
README
Introducing the Ultimate Golang Blueprint Library
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](#install)
- [Frameworks Supported](#frameworks-supported)
- [Database Support](#database-support)
- [Advanced Features](#advanced-features)
- [Blueprint UI](#blueprint-ui)
- [Usage Example](#usage-example)
- [GitHub Stats](#github-stats)
- [License](#license)
Install
```bash
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:
```bash
go-blueprint create
```
You can also use the provided flags to set up a project without interacting with the UI.
```bash
go-blueprint create --name my-project --framework gin --driver postgres --git commit
```
See `go-blueprint create -h` for all the options and shorthands.
Frameworks Supported
- [Chi](https://github.com/go-chi/chi)
- [Gin](https://github.com/gin-gonic/gin)
- [Fiber](https://github.com/gofiber/fiber)
- [HttpRouter](https://github.com/julienschmidt/httprouter)
- [Gorilla/mux](https://github.com/gorilla/mux)
- [Echo](https://github.com/labstack/echo)
Database Support
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:
- [Mysql](https://github.com/go-sql-driver/mysql)
- [Postgres](https://github.com/jackc/pgx/)
- [Sqlite](https://github.com/mattn/go-sqlite3)
- [Mongo](https://go.mongodb.org/mongo-driver)
- [Redis](https://github.com/redis/go-redis)
Advanced Features
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](https://htmx.org/) support using [Templ](https://templ.guide/)
- CI/CD workflow setup using [Github Actions](https://docs.github.com/en/actions)
- [Websocket](https://pkg.go.dev/nhooyr.io/websocket) sets up a websocket endpoint
- [Tailwind](https://tailwindcss.com/) css framework
Note: selecting tailwind option automatically selects htmx.
Blueprint UI
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](https://go-blueprint.dev)
Usage Example
Here's an example of setting up a project with a specific database driver:
```bash
go-blueprint create --name my-project --framework gin --driver postgres --git commit
```
Advanced features are accessible with the --advanced flag
```bash
go-blueprint create --advanced
```
Advanced features can be enabled using the `--feature` flag along with the `--advanced` flag.
HTMX:
```bash
go-blueprint create --advanced --feature htmx
```
CI/CD workflow:
```bash
go-blueprint create --advanced --feature githubaction
```
Websocket:
```bash
go-blueprint create --advanced --feature websocket
```
Tailwind:
```bash
go-blueprint create --advanced --feature tailwind
```
Or all features at once:
```bash
go-blueprint create --name my-project --framework chi --driver mysql --advanced --feature htmx --feature githubaction --feature websocket --feature tailwind --git commit
```
**Visit [documentation](https://docs.go-blueprint.dev) to learn more about blueprint and its features.**
Github Stats
License
Licensed under [MIT License](./LICENSE)