README: add local development doc and agola demo link

This commit is contained in:
Simone Gotti 2019-07-02 10:54:44 +02:00
parent 88b7ea3de6
commit d6034f3cb8
2 changed files with 49 additions and 2 deletions

View File

@ -1,3 +1,12 @@
## Agola
# Agola
CI/CD redefined
CI/CD redefined
## Try it
See [the agolademo example](https://agola.io/tryit)
## Local development
See [how to develop agola](doc/devel.md)

38
doc/devel.md Normal file
View File

@ -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
```