154 lines
4.5 KiB
Markdown
154 lines
4.5 KiB
Markdown
## Realize
|
|
|
|
[](https://godoc.org/github.com/tockins/realize/realize)
|
|
[](https://travis-ci.org/tockins/realize)
|
|
[](https://raw.githubusercontent.com/tockins/realize/v1/LICENSE)
|
|
[](https://github.com/tockins/realize-examples)
|
|
[](https://gitter.im/tockins/realize?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
|
|
|
|
|
|
A Golang build system with file watchers, output streams and live reload. Run, build and watch file changes with custom paths
|
|
|
|
|
|
|
|
#### Features
|
|
|
|
- Build, Install, Test and Run at the same time
|
|
- Live reload on file changes (re-build, re-install and re-run)
|
|
- Watch custom paths
|
|
- Watch specific file extensions
|
|
- Multiple projects support
|
|
- Output streams
|
|
- Execution times
|
|
|
|
#### Installation and usage
|
|
|
|
- Run this for get/install it:
|
|
|
|
```
|
|
$ go get github.com/tockins/realize
|
|
```
|
|
|
|
- From the root of a project/projects:
|
|
|
|
```
|
|
$ realize add
|
|
```
|
|
|
|
If not exists already, It will create a realize.config.yaml file.
|
|
|
|
You can even pass custom parameters for add a project. This is a list of the supported fields:
|
|
|
|
```
|
|
--name="Project Name" -> Name, if not specified takes the working directory name
|
|
--base="server" -> Base Path, if not specified takes the working directory name
|
|
--build -> Go build, if not specified takes "false"
|
|
--bin -> Go intall, if not specified takes "true"
|
|
--run -> Go run, if not specified takes "true"
|
|
--fmt -> Go fmt, if not specified takes "true"
|
|
```
|
|
|
|
Add a project whenever you want.
|
|
|
|
```
|
|
$ realize add
|
|
```
|
|
```
|
|
$ realize add --base="mypath"
|
|
```
|
|
```
|
|
$ realize add --name="My Project" --build
|
|
```
|
|
```
|
|
$ realize add --name="My Project" --base="/projects/package" --build
|
|
```
|
|
```
|
|
$ realize add --name="My Project" --base="projects/package" --build --run
|
|
```
|
|
- Remove a project by his name
|
|
|
|
```
|
|
$ realize remove --name="Project Name"
|
|
```
|
|
- Lists all projects
|
|
|
|
```
|
|
$ realize list
|
|
```
|
|
- Build, Run and watch file changes. Realize will re-build and re-run your projects on each changes
|
|
|
|
```
|
|
$ realize run
|
|
```
|
|
|
|
#### Config file example
|
|
|
|
- For more examples check [Realize Examples](https://github.com/tockins/realize-examples)
|
|
|
|
```
|
|
version: "1.0"
|
|
projects:
|
|
- app_name: App One -> name
|
|
app_path: one -> root path
|
|
app_run: true -> enable/disable go run (require app_bin)
|
|
app_bin: true -> enable/disable go install
|
|
app_build: false -> enable/disable go build
|
|
app_fmt: true -> enable/disable go fmt
|
|
app_watcher:
|
|
preview: true -> prints the observed files on startup
|
|
paths: -> paths to observe for live reload
|
|
- /
|
|
ignore_paths: -> paths to ignore
|
|
- vendor
|
|
- bin
|
|
exts: -> file extensions to observe for live reload
|
|
- .go
|
|
- app_name: App Two -> another project
|
|
app_path: two
|
|
app_run: true
|
|
app_build: true
|
|
app_bin: true
|
|
app_watcher:
|
|
paths:
|
|
- /
|
|
ignore_paths:
|
|
- vendor
|
|
- bin
|
|
exts:
|
|
- .go
|
|
```
|
|
|
|
#### Next releases
|
|
|
|
#####Milestone 1.0
|
|
|
|
- [x] Cli start, remove, add, list, run
|
|
- [x] Remove duplicate projects
|
|
- [x] Support for multiple projects
|
|
- [x] Watcher files preview
|
|
- [x] Support for directories with duplicates names
|
|
- [ ] Go test support
|
|
- [x] Go fmt support
|
|
- [ ] Cli fast run
|
|
- [x] Execution times for build/install
|
|
- [x] Go doc
|
|
- [x] Support for server start/stop
|
|
- [x] Stream projects output
|
|
- [x] Cli feedback
|
|
|
|
##### Milestone 1.1
|
|
- [ ] Test under windows
|
|
- [ ] Unit test
|
|
|
|
|
|
#### Contacts
|
|
|
|
- Chat with us [Gitter](https://gitter.im/tockins/realize)
|
|
|
|
- [Alessio Pracchia](https://www.linkedin.com/in/alessio-pracchia-38a70673)
|
|
- [Daniele Conventi]()
|
|
|
|
|