realize

Go to file

Daniele Conventi 8f392abe70 Fixed timestamp on logs		2016-08-23 14:49:44 +02:00
realize	Fixed timestamp on logs	2016-08-23 14:49:44 +02:00
.gitignore	ignore bin	2016-08-03 16:47:37 +02:00
.travis.yml	before install	2016-08-17 21:56:44 +02:00
LICENSE	realize dev	2016-07-12 10:18:02 +02:00
README.md	examples updated	2016-08-22 18:08:11 +02:00
glide.lock	dependencies	2016-07-30 01:02:57 +02:00
glide.yaml	dependencies	2016-07-30 01:02:57 +02:00
main.go	paths logic rewritten	2016-08-23 02:07:07 +02:00

README.md

Realize

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, Fmt 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
Highly customizable
Fast run

Installation and usage

Run this to get/install:
```
$ go get github.com/tockins/realize
```

From project/projects root execute:

$ realize add

It will create a realize.config.yaml file if it doesn't exist already and adds the working directory as the project.

Otherwise if a config file already exists it adds another project to the existing config file.

The add command supports the following custom parameters:

--name="Project Name"  -> Name, if not specified takes the working directory name
--path="server"        -> Base Path, if not specified takes the working directory name    
--build                -> Enables the build   
--nobin                -> Disables the installation
--norun                -> Disables the run
--nofmt                -> Disables the fmt (go fmt)

Examples:

$ realize add

$ realize add --path="mypath"

$ realize add --name="My Project" --build

$ realize add --name="My Project" --path="/projects/package" --build

$ realize add --name="My Project" --path="projects/package" --build --norun

Remove a project by its 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 change.

$ realize run

Fast run launches a project from its working directory without a config file

$ realize fast

The fast command supports the following custom parameters:

--build                -> Enables the build   
--nobin                -> Disables the installation
--norun                -> Disables the run
--nofmt                -> Disables the fmt (go fmt) 
--config               -> Take the defined settings if exist a config file

Config file example

For more examples check 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

Cli start, remove, add, list, run
Remove duplicate projects
Support for multiple projects
Watcher files preview
Support for directories with duplicates names
Go test support
Go fmt support
Cli fast run
Execution times for build/install
Go doc
Support for server start/stop
Stream projects output
Cli feedback

Milestone 1.1

Test under windows
Unit test