additional info
This commit is contained in:
parent
179e3ef820
commit
c5373ea0cd
53
README.md
53
README.md
|
@ -13,7 +13,10 @@
|
||||||
|
|
||||||
#### Realize is the Go tool that is focused to speed up and improve developers workflow.
|
#### Realize is the Go tool that is focused to speed up and improve developers workflow.
|
||||||
|
|
||||||
Automate your work pipeline, integrate additional tools of third party, define custom cli commands and reload projects at each changed without stop to write code.
|
Automate the most recurring operations needed for development, define what you need only one time, integrate additional tools of third party, define custom cli commands and reload projects at each file change without stop to write code.
|
||||||
|
|
||||||
|
Various operations can be programmed for each project, which can be executed at startup, at stop, and at each file change.
|
||||||
|
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="http://i.imgur.com/KpMSLnE.png">
|
<img src="http://i.imgur.com/KpMSLnE.png">
|
||||||
|
@ -22,19 +25,22 @@ Automate your work pipeline, integrate additional tools of third party, define c
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
|
|
||||||
- Highly customizable
|
- Two watcher types: file system and polling
|
||||||
- Setup step by step
|
- Logs and errors files
|
||||||
- Live reload
|
- Projects setup step by step
|
||||||
- Support for multiple projects
|
- After/Before custom commands
|
||||||
- Save logs on files
|
- Custom environment variables
|
||||||
- Web panel for a smart view
|
- Multiple projects at the same time
|
||||||
- Build, install, run, test, fmt, generate, vet and much more
|
- Custom arguments to pass at each project
|
||||||
- Watch custom paths and specific file extensions
|
- Docker support (only with polling watcher)
|
||||||
- Multiple watching methods (Polling, File watcher)
|
- Live reload on file change (extensions and paths customizable)
|
||||||
- Docker support
|
- Support for most go commands (install, build, run, vet, test, fmt and much more)
|
||||||
|
- Web panel for a smart control of the workflow
|
||||||
|
|
||||||
v 1.5
|
v 1.5
|
||||||
|
|
||||||
|
- [ ] Use cases
|
||||||
|
- [ ] Tests
|
||||||
- [ ] Watch gopath dependencies
|
- [ ] Watch gopath dependencies
|
||||||
- [ ] Web panel, download logs
|
- [ ] Web panel, download logs
|
||||||
- [ ] Multiple configurations (dev, production)
|
- [ ] Multiple configurations (dev, production)
|
||||||
|
@ -44,12 +50,12 @@ v 1.5
|
||||||
#### Wiki
|
#### Wiki
|
||||||
|
|
||||||
- [Getting Started](#installation)
|
- [Getting Started](#installation)
|
||||||
|
- [Config sample](#config-sample) - Sample config file
|
||||||
- [Run cmd](#run) - Run a project
|
- [Run cmd](#run) - Run a project
|
||||||
- [Add cmd](#add) - Add a new project
|
- [Add cmd](#add) - Add a new project
|
||||||
- [Init cmd](#init) - Make a custom config step by step
|
- [Init cmd](#init) - Make a custom config step by step
|
||||||
- [Remove cmd](#remove) - Remove a project
|
- [Remove cmd](#remove) - Remove a project
|
||||||
- [List cmd](#list) - List the projects
|
- [List cmd](#list) - List the projects
|
||||||
- [Config sample](#config-sample) - Sample config file
|
|
||||||
- [Support](#support-us-and-suggest-an-improvement)
|
- [Support](#support-us-and-suggest-an-improvement)
|
||||||
|
|
||||||
|
|
||||||
|
@ -58,7 +64,7 @@ Run this to get/install:
|
||||||
```
|
```
|
||||||
$ go get github.com/tockins/realize
|
$ go get github.com/tockins/realize
|
||||||
```
|
```
|
||||||
#### Commands
|
#### Commands available
|
||||||
|
|
||||||
- ##### Run
|
- ##### Run
|
||||||
From project/projects root execute:
|
From project/projects root execute:
|
||||||
|
@ -147,9 +153,9 @@ $ go get github.com/tockins/realize
|
||||||
```
|
```
|
||||||
settings:
|
settings:
|
||||||
legacy:
|
legacy:
|
||||||
status: true // legacy watch status
|
status: true // enable polling watcher instead fsnotifiy
|
||||||
interval: 10s // polling interval
|
interval: 10s // polling interval
|
||||||
resources: // files names related to streams
|
resources: // files names
|
||||||
outputs: outputs.log
|
outputs: outputs.log
|
||||||
logs: logs.log
|
logs: logs.log
|
||||||
errors: errors.log
|
errors: errors.log
|
||||||
|
@ -161,10 +167,10 @@ $ go get github.com/tockins/realize
|
||||||
projects:
|
projects:
|
||||||
- name: coin
|
- name: coin
|
||||||
path: coin // project path
|
path: coin // project path
|
||||||
environment: // env variables
|
environment: // env variables available at startup
|
||||||
test: test
|
test: test
|
||||||
myvar: value
|
myvar: value
|
||||||
commands:
|
commands: // go commands supported
|
||||||
vet: true
|
vet: true
|
||||||
fmt: true
|
fmt: true
|
||||||
test: false
|
test: false
|
||||||
|
@ -173,10 +179,10 @@ $ go get github.com/tockins/realize
|
||||||
status: true
|
status: true
|
||||||
build:
|
build:
|
||||||
status: false
|
status: false
|
||||||
args:
|
args: // additional params for the command
|
||||||
- -race
|
- -race
|
||||||
run: true
|
run: true
|
||||||
args:
|
args: // arguments to pass at the project
|
||||||
- --myarg
|
- --myarg
|
||||||
watcher:
|
watcher:
|
||||||
preview: false // watched files preview
|
preview: false // watched files preview
|
||||||
|
@ -186,16 +192,15 @@ $ go get github.com/tockins/realize
|
||||||
- vendor
|
- vendor
|
||||||
exts: // watched extensions
|
exts: // watched extensions
|
||||||
- .go
|
- .go
|
||||||
scripts:
|
scripts: // custom scripts
|
||||||
- type: before // type
|
- type: before // type (after/before)
|
||||||
command: ./ls -l // command
|
command: ./ls -l // command
|
||||||
changed: true // relaunch when a file changes
|
changed: true // relaunch when a file change
|
||||||
startup: true // launch at start
|
startup: true // launch at start
|
||||||
- type: after
|
- type: after
|
||||||
command: ./ls
|
command: ./ls
|
||||||
changed: true
|
changed: true
|
||||||
streams: // enable/disable streams
|
streams: // save logs/errors/outputs on files
|
||||||
cli_out: true
|
|
||||||
file_out: false
|
file_out: false
|
||||||
file_log: false
|
file_log: false
|
||||||
file_err: false
|
file_err: false
|
||||||
|
|
Loading…
Reference in New Issue