Skip to content
Snippets Groups Projects
Commit 281a5939 authored by Mirco Nasuti's avatar Mirco Nasuti
Browse files

update readme + circle.yml captain version

parent 0c030cef
No related branches found
No related tags found
No related merge requests found
......@@ -2,34 +2,15 @@
[![License](https://img.shields.io/badge/license-AGPL--3.0-blue.svg)](https://www.gnu.org/licenses/agpl-3.0.html)
## Usage in development environment
## Usage
* Build and run the project (including clean target): `./go.sh`
* Build the project (including clean target): `./build.sh`
* Run the project: `./run.sh`
* Show live logs: `./log.sh` (CTRL+C to quit)
* Stop and remove the running container: `./halt.sh`
* Clean Maven cache, etc: `./clean.sh`
## Usage in building environment
* Build a versioned image: `./captain_build.sh` (only if `$WORKSPACE=$(pwd)`) or `export WORKSPACE=<path-to-workspace> && captain build`
* Build and test an image: `./captain_test.sh` or `captain test`
* Run the latest image with a non-persistent postgres (only use this for testing purpose): `./captain_run.sh`
* Build a versioned image: `./build.sh`
* Build and test an image: `./test.sh`
## Deployment
* See here: https://hub.docker.com/r/hbpmip/portal-backend/
## Generate PDF API documentation on build
Uncomment the following line in src/docker/build/build-in-docker.sh :
`mvn swagger2markup:convertSwagger2markup asciidoctor:process-asciidoc`
## Tips
* Do not forget to set up the CLIENT_SECRET environment variable when deploying.
## License
Copyright © 2016 LREN CHUV
......
......@@ -3,7 +3,7 @@ machine:
- docker
dependencies:
pre:
- curl -sL https://github.com/harbur/captain/releases/download/v0.0.1/captain > ~/bin/captain
- curl -sL https://github.com/harbur/captain/releases/download/v1.0.0/captain > ~/bin/captain
- chmod u+x ~/bin/captain
test:
override:
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment