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 <[email protected]> --------- Co-authored-by: Albin Ramovic <[email protected]>
cap-js · Dec 6, 2024 · 0f9b83f · 0f9b83f
1 parent 6ef7a87
commit 0f9b83f
Showing 1 changed file with 23 additions and 0 deletions.
diff --git 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