https://github.com/rudrodip/ginit
ginit is a command-line tool for initializing go projects with predefined structures and configurations
https://github.com/rudrodip/ginit
cli go
Last synced: 9 months ago
JSON representation
ginit is a command-line tool for initializing go projects with predefined structures and configurations
- Host: GitHub
- URL: https://github.com/rudrodip/ginit
- Owner: rudrodip
- License: mit
- Created: 2024-01-01T13:52:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-01T14:41:52.000Z (over 2 years ago)
- Last Synced: 2025-09-13T14:26:48.554Z (10 months ago)
- Topics: cli, go
- Language: Go
- Homepage:
- Size: 148 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ginit
Ginit is a command-line tool for initializing projects with predefined structures and configurations. It aims to streamline the project setup process by providing a simple interface to generate project skeletons.
## Features
- **Easy Project Initialization:** Quickly set up projects with predefined structures.
- **Project Type Options:** Choose from different project types (Blank, CLI, Backend, etc.) with associated generator functions.
- **Customizable Templates:** Define your own project structures and templates for various project types.
- **Dynamic Folder and File Generation:** Generate projects with dynamic folder structures and files.
- **Cross-Platform Support:** Works on Linux, macOS, and Windows WSL.
## Supported Platforms
- Linux
- macOS
- Windows WSL
## Installation
### Linux and macOS
To install ginit on Linux or macOS, use the following one-liner:
```bash
curl -sSL https://raw.githubusercontent.com/rudrodip/ginit/main/install.sh | bash
```
### Windows WSL
To install ginit on Windows WSL, use the following one-liner:
```bash
curl -sSL https://raw.githubusercontent.com/rudrodip/ginit/main/install.sh | bash
```
## Usage
### Generating a Project
Run the following command to generate a new project:
```bash
ginit
```
Follow the prompts to choose the project type and provide necessary details.
### Customizing Templates
You can customize project templates by modifying the generator functions and project structures in the code.
## Contributing
Contributions are welcome! Please check the [contribution guidelines](CONTRIBUTING.md) for more details.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.