diff --git a/README.md b/README.md index 94f261a..bcd6dd0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ -## Agola +# Agola -CI/CD redefined \ No newline at end of file +CI/CD redefined + +## Try it + +See [the agolademo example](https://agola.io/tryit) + + +## Local development + +See [how to develop agola](doc/devel.md) \ No newline at end of file diff --git a/doc/devel.md b/doc/devel.md new file mode 100644 index 0000000..faaec52 --- /dev/null +++ b/doc/devel.md @@ -0,0 +1,38 @@ +### Local development + +#### Start the web interface + +* Clone the [agola-web repository](https://github.com/agola-io/agola-web) + +For the first time you'll need the `vue cli` and its services installed as global modules: + +``` +npm install -g @vue/cli @vue/cli-service-global +``` + +Inside the `agola-web` repository run: + +``` +npm install +npm run serve +``` + +### Build the agola binary + +``` +make +``` + +### Start the agola server + +* Copy the `example/config.yml` where you prefer + +``` +./bin/agola serve --toolbox-path $PWD/bin/agola-toolbox --embedded-etcd --config /path/to/your/config.yml --components all-base,executor +``` + +or use an external etcd (set it in the config.yml): + +``` +./bin/agola serve --toolbox-path $PWD/bin/agola-toolbox --config /path/to/your/config.yml --components all-base,executor +```