https://github.com/itzhep/gomon
nodemon but in golang !
https://github.com/itzhep/gomon
cli golang nodemon
Last synced: 9 months ago
JSON representation
nodemon but in golang !
- Host: GitHub
- URL: https://github.com/itzhep/gomon
- Owner: Itzhep
- License: mit
- Created: 2024-09-23T21:14:40.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-21T14:30:31.000Z (over 1 year ago)
- Last Synced: 2024-12-21T14:31:27.735Z (over 1 year ago)
- Topics: cli, golang, nodemon
- Language: Go
- Homepage:
- Size: 20.5 MB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🛠️ Gomon - A Nodemon Clone Go File Watcher 🚀
Gomon is a Go-based file watcher that automatically reloads your application when file changes are detected. Inspired by nodemon, it helps streamline development by automatically restarting your app.
## Build Stats
[](https://github.com/Itzhep/gomon/actions/workflows/go.yml)
## Project Stats
## 📦 Features
- 🔄 **Automatic file watching and reloading**: Detects file changes and restarts your application automatically.
- 🎨 **CLI with color support**: Enhanced visibility with color-coded output.
- 📝 **Simple and clean configuration**: Minimal setup required to get started.
- 🐳 **Docker support**: Run your application inside Docker containers.
- 🌐 **Live reload server**: Supports live reloading for browser-based applications.
## 🏗️ Installation
### Via Go
To install Gomon, use the following command:
```bash
go install github.com/Itzhep/gomon@latest
```
### Manual Build
1. Clone the repository:
```bash
git clone https://github.com/Itzhep/gomon.git
cd gomon
```
2. Build the project:
```bash
go build -o gomon
```
3. Install the Project:
```bash
go install
```
4. Move to bin (optional):
```bash
move gomon.exe C:\path\to\your\bin
```
## 🚀 Usage
1. Start Gomon with the path to your main application file:
```bash
gomon start --app path/to/your/app.go
```
2. **Press `rs`** in the CLI to manually restart the application.
## 🛠️ Configuration
Gomon supports a variety of configurations directly from the CLI. You can specify the file to watch and other options like color settings for better CLI appearance.
### CLI Options
- `--app, -a`: Path to the Go application to run (required)
- `--debounce, -d`: Debounce duration for file changes (default: 1s)
- `--docker`: Use Docker for restarting the app
- `--exclude, -e`: Directories to exclude from watching (default: .git, vendor, node_modules)
- `--verbose, -v`: Enable verbose logging
## 📝 Example
Here's a basic example of how to use Gomon:
```bash
gomon start --app path/to/your/app.go
```
This command starts Gomon, watches for file changes, and restarts your application automatically.
## 🐳 Docker Support
Gomon can be run inside a Docker container. Use the provided `Dockerfile` and `docker-compose.yml` for easy setup.
## 🗂️ Contributing
Contributions are welcome! Please submit a pull request or open an issue if you find any bugs or have suggestions.
## 🌟 Star the Project
If you find Gomon useful, please give it a star on [GitHub](https://github.com/Itzhep/gomon) to support development and stay updated with new features.
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
🚀 Happy coding with Gomon!