https://github.com/pol-cova/goginit
GoGinit is a user-friendly CLI tool that helps you quickly set up new Go backend projects with a choice of popular frameworks like Echo and Gin.
https://github.com/pol-cova/goginit
backend go golang golang-tools
Last synced: over 1 year ago
JSON representation
GoGinit is a user-friendly CLI tool that helps you quickly set up new Go backend projects with a choice of popular frameworks like Echo and Gin.
- Host: GitHub
- URL: https://github.com/pol-cova/goginit
- Owner: pol-cova
- License: mit
- Created: 2024-07-27T21:25:54.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-24T15:20:02.000Z (almost 2 years ago)
- Last Synced: 2024-08-24T16:36:16.552Z (almost 2 years ago)
- Topics: backend, go, golang, golang-tools
- Language: Go
- Homepage:
- Size: 13.2 MB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# GoGinit 🚀
**GoGinit** is a CLI tool for initializing Go backend projects with ease. Perfect for kickstarting your Go projects with structured templates and framework options!
## Features 🌟
- **Seamless Initialization**: Set up a new Go project in no time.
- **Framework Options**: Choose between Echo, Gin, Fiber, Fuego, or other supported frameworks.
- **Customizable**: Optionally include configuration files and setup scripts.
- **SQLite Database Setup**: Initialize a SQLite database with your project.
- **Start Command**: Easily run your Go project with a single command.
- **Clean Command**: Remove unused libraries in the mod file.
## Installation 🛠️
### Homebrew 🍺 (macOS/Linux)
1. **Tap the Homebrew repository:**
```sh
brew tap pol-cova/goginit
```
2. **Install GoGinit:**
```sh
brew install goginit
```
### Manual Installation
1. **Download the latest binary from the [releases page](https://github.com/pol-cova/GoGinit/releases).**
2. **Extract the binary and move it to a directory in your `PATH`:**
```sh
tar -xzf goginit___.tar.gz
sudo mv goginit /usr/local/bin/
```
## Usage 🎉
### Initialize a New Project
To initialize a new Go project, run:
```sh
goginit init
```
### Start the Project
To run the main.go file located in `cmd/projectName/main.go`, use:
```sh
cd
goginit start
```
**Options:**
- **``**: Name of the project (required).
### Clean the Mod
To clean the mod file use:
```sh
cd
goginit clean
```
### Framework Options
- **`echo`**: For the Echo framework
- **`gin`**: For the Gin framework
- **`fiber`**: For the Fiber framework
- **`fuego`**: For the Fuego framework
- **`martini`**: For the Martini framework
- **`chi`**: For the Chi framework
- **`mux`**: For the Mux framework
- **`GoFr`**: For the GoFr framework
- **`Fuego`**: For the Fuego framework
- **`default`**: For the native `net/http`
## Future Updates 🔮
- **Optimization**: Upcoming updates will focus on optimizing performance and improving overall efficiency.
- **Test**: Implementing test options for your backend using the CLI tool.
- **Benchmarking**: Adding benchmarking options to the CLI tool.
## Contribution Guidelines 🤝
We welcome contributions! To contribute:
1. **Fork the repository** and clone your fork.
2. **Create a new branch** for your changes.
3. **Make your changes** and test thoroughly.
4. **Submit a pull request** with a detailed description.
## License 📄
GoGinit is licensed under the [MIT License](LICENSE).
## Contact 📫
For support or questions, reach out to us at [polc394@gmail.com](mailto:polc394@gmail.com).
---
**Happy Coding!** 🎉
---