|
1 | | -# Go Bootstrapper 🐹⚡ |
2 | | -> A scaffold CLI project for Golang project enabling creation of new project without worring about installing dependencies, setting up linters |
3 | | -just use CLI tools to generate the pre-configured templates. |
| 1 | +# bootstrap-cli |
| 2 | +A scaffold CLI for Golang projects that helps you create new projects **without worrying about installing dependencies, setting up linters, or boilerplate configuration**. |
| 3 | +Just use the CLI to generate **pre-configured templates** and start building instantly. |
4 | 4 |
|
5 | 5 | --- |
6 | 6 |
|
7 | | -## ✨ Features |
8 | | -- 🏗 **create new golang projects instantly** |
9 | | -- ⚡ **Framework-ready** templates |
10 | | -- 📂 **Standardized structure**: `cmd/`, `internal/` |
11 | | -- 🔮 Designed to be **extensible** (bring your own templates) |
| 7 | +## Installation |
12 | 8 |
|
13 | | ---- |
14 | | - |
15 | | -## 📦 Installation |
| 9 | +Make sure you have [Go](https://golang.org/doc/install) installed (Go 1.20+ recommended). |
| 10 | +Then install the CLI: |
16 | 11 |
|
17 | 12 | ```bash |
18 | 13 | go install github.com/upsaurav12/bootstrap@latest |
19 | 14 |
|
| 15 | +``` |
| 16 | + |
| 17 | +## Usage |
| 18 | +```bash |
| 19 | +bootstrap new <your_project_name --type=rest --router=gin --port=8080 |
| 20 | +``` |
| 21 | + |
| 22 | +- ``--type`` : what kind of project ?. |
| 23 | +- ``--router`` : framework (i.e gin or chi ). |
| 24 | +- ``--port`` : what should be your port where your server would be running. |
| 25 | + |
| 26 | +```base |
| 27 | +cd <your_project_name> && go mod tidy |
| 28 | +``` |
| 29 | +this will give take you in your project directory and install the dependencies, here we go your project is now ready. |
| 30 | + |
| 31 | + |
| 32 | +## TODO's |
| 33 | +- [ ] Add more project types like microservices, cli-app, rest, etc. |
| 34 | +- [ ] Add more frameworks in REST like echo, fiber |
| 35 | +- [ ] Add flags for automating setup of linters, CI/CD pipelines, tests, etc. |
| 36 | +- [ ] Add `add` command for adding features like auth, db, services, etc. |
| 37 | +- [ ] Add `update` command for automating available dependency update. |
| 38 | + |
| 39 | + |
| 40 | + |
20 | 41 |
|
0 commit comments