X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=README.md;h=c7bbd8116a5a76ad06959c1b2ecac76d24f57f68;hb=10f834104ead71661cff6823a79b9346169b79e1;hp=d1bf49d8cfcf3cb16a5b437d8868c7a1d5a7d881;hpb=ffc97e085589fae2e020705910b312d1307627e3;p=cps.git diff --git a/README.md b/README.md index d1bf49d8cf..c7bbd8116a 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,9 @@ # Configuration Persistence Service -This folder contains all files for -[Configuration Persistence Service](https://wiki.onap.org/pages/viewpage.action?pageId=81406119). +## General Information +* [CPS Project Wiki](https://wiki.onap.org/display/DW/Configuration+Persistence+Service+Project) + +## For Developers +* [Developer Wiki](https://wiki.onap.org/display/DW/Configuration+Persistence+Service+Developer%27s+Landing+Page) +* [Building and running CPS locally](docker-compose/README.md) -The code here is related to CPS POC, then it must be kept self contained in this cps folder to prevent any impact on -current ccsdk components and to be ready to be moved in its own repo once CPS becomes a standalone project. - - -## Running Locally - -* Run a postgres container instance and create `cpsdb' database: - -``` -CREATE USER cps WITH PASSWORD 'cps'; -CREATE DATABASE cpsdb OWNER cps; -``` - -* Build (from cps root folder) - -```bash -mvn clean package -``` - -* Run (from cps root folder) - -```bash -java -DDB_HOST=localhost -DDB_USERNAME=cps -DDB_PASSWORD=cps -jar cps-rest/target/cps-rest-0.0.1-SNAPSHOT.jar -``` - -* Browse - * [Swagger UI](http://localhost:8080/swagger-ui/index.html) - * OpenAPI Specification in [JSON](http://localhost:8080/api/cps/openapi.json) - or [YAML](http://localhost:8080/api/cps/openapi.yaml) format