From 0f9b83fd39c2e22ce1ca79de154247db3c887b00 Mon Sep 17 00:00:00 2001 From: Sebastian Wennemers Date: Fri, 6 Dec 2024 08:48:57 +0100 Subject: [PATCH] Include Calesi setup steps in the contribution guide (#106) * Update CONTRIBUTING.md Include Calesi setup steps in the contribution guide. * Update CONTRIBUTING.md Co-authored-by: Albin Ramovic <68844975+aramovic79@users.noreply.github.com> --------- Co-authored-by: Albin Ramovic <68844975+aramovic79@users.noreply.github.com> --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6319573..67f6711 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,3 +36,26 @@ The following rule governs code contributions: * We use GitHub issues to track bugs and enhancement requests. * Please provide as much context as possible when you open an issue. The information you provide must be comprehensive enough to reproduce that issue for the assignee. + +## Development Setup + +As this is a CAP plugin, it is best to develop in the following calesi environment: +``` +git clone --recursive https://github.com/cap-js/calesi.git +cd calesi +npm i +``` +Then clone this repository inside the calesi projects plugin folder: +``` +cd plugins +git clone https://github.com/cap-js/ORD +cd ORD +npm i +``` +For testing an example app is available in the `xmpl` folder: +``` +#If not already globally installed, install cds-dk +npm install -g @sap/cds-dk +cds w xmpl +``` +After the CAP app has started, open this link in your browser: http://localhost:4004/open-resource-discovery/v1/documents/1