If you want to use prefab as your app generator, simply install the prefab binaries. The prefab binaries have no external dependencies.
To contribute to the prefab source code or documentation, you should fork the prefab GitHub project and clone it to your local machine.
Finally, you can install the prefab source code with Go(programming language), build the binaries yourself, and run prefab that way. Building the binaries is an easy task for an experienced go getter.
Use the installation instructions in the prefab documentation.
TBD: steps to get release binary for different plaform
Prefab uses the Go Modules support built into Go 1.12 to build. The easiest way is to clone prefab in a directory outside of GOPATH, as in the following example:
> mkdir $HOME/src
> cd $HOME/src
> git clone https://github.com/yantrashala/prefab.git
> cd prefab
> go run mage.go install
If you are a Windows user, substitute the $HOME
environment variable above with %USERPROFILE%
.
TBD: links to documentation and tutorials Docker Overview https://www.tutorialspoint.com/docker/docker_overview.htm
> git clone https://github.com/yantrashala/prefab.git
> cd prefab
> docker build -t ps/fab .
...
> docker run --rm -it -p9876:9876 ps/fab ./fab server
> cd prefab
> go get ./
> cd ui
> npm install
> npm run build
> cd ..
> go get -d -v
> go test ./...
> go run main.go server
> cd prefab
> make compile
> make start-server
...
...
> make stop-server
or use mage locally
> go get -d github.com/magefile/mage
> go run $GOPATH/src/github.com/magefile/mage/bootstrap.go install
> cd prefab
> mage prefab
>./bin/fab server
first install chokidar globally (assuming node & npm are already installed)
> npm install -g chokidar-cli
> cd prefab
> make compile
> make watch run="make stop-server go-get go-build start-server"
...
Optionally for local development
- Login with your user credentials and then Fork it
- Download your fork to your PC (git clone https://github.com/your_username/prefab && cd prefab)
- Create your feature branch (git checkout -b my-new-feature)
- Make changes and add them (git add .)
- Commit your changes (git commit -m 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create new pull request
- Wait for it to get reviewed and merged