Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Include Calesi setup steps in the contribution guide.
  • Loading branch information
swennemers authored Dec 5, 2024
1 parent 6ef7a87 commit fec6f7e
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 for the calesi setup
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

0 comments on commit fec6f7e

Please sign in to comment.