Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,16 @@ Should you wish to work on an issue, please claim it first by commenting on the

If you have questions about one of the issues, please comment on them, and one of the maintainers will clarify.

## Local development setup

`./tests/incidents-app/` contains a working sample with which the plugin can be locally tested and which is used by the integration tests.

`cd ./tests/incidents-app/` into the app and run `cds watch` within the folder to have the Incidents app running but with the local version of the plugin.

If you want to test your implementation against the BTP Object Store or the Malware Scanning Service, use [`cds bind`](https://cap.cloud.sap/docs/advanced/hybrid-testing) and run with `cds watch --profile hybrid` to test those changes.

If you are prompted locally for authentication use CAPs local development mock values of "alice" and "1234".

## Contributing Code or Documentation

You are welcome to contribute code in order to fix a bug or to implement a new feature that is logged as an issue.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ We can try out the scenarios where the attachments contents are stored locally i
3. The `Attachments` type has generated an out-of-the-box Attachments table (see 1) at the bottom of the Object page:
<img width="1300" alt="Attachments Table" style="border-radius:0.5rem;" src="etc/facet.png">

4. **Upload a file** by going into Edit mode and either using the **Upload** button on the Attachments table or by drag/drop. Then click the **Save** button to have that file stored that file in the dedicated resource (database, S3 bucket, etc.). We demonstrate this by uploading the PDF file from [_xmpl/db/content/Solar Panel Report.pdf_](./xmpl/db/content/Solar%20Panel%20Report.pdf):
4. **Upload a file** by going into Edit mode and either using the **Upload** button on the Attachments table or by drag/drop. Then click the **Save** button to have that file stored that file in the dedicated resource (database, S3 bucket, etc.). We demonstrate this by uploading the PDF file from [_tests/integration/content/sample.pdf_](./tests/integration/content/sample.pdf):
<img width="1300" alt="Upload an attachment" style="border-radius:0.5rem;" src="etc/upload.gif">

6. **Delete a file** by going into Edit mode and selecting the file(s) and by using the **Delete** button on the Attachments table. Then click the **Save** button to have that file deleted from the resource (database, S3 bucket, etc.). We demonstrate this by deleting the previously uploaded PDF file: `Solar Panel Report.pdf`
Expand Down Expand Up @@ -189,7 +189,7 @@ To ensure tenant identification when using a shared object store instance, the p

## Contributing

This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-js/attachments/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-js/attachments/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, the **local development setup**, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).

## Code of Conduct

Expand Down
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -90,5 +90,8 @@
}
}
}
}
},
"workspaces": [
"tests/incidents-app/"
]
}
2 changes: 1 addition & 1 deletion tests/incidents-app/app/incidents/webapp/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
}
}
},
"initialLoad": "Enabled",
"liveMode": true,
"controlConfiguration": {
"@com.sap.vocabularies.UI.v1.LineItem": {
"tableSettings": {
Expand Down
3 changes: 0 additions & 3 deletions xmpl/.gitignore

This file was deleted.

13 changes: 0 additions & 13 deletions xmpl/README.md

This file was deleted.

7 changes: 0 additions & 7 deletions xmpl/db/attachments.cds

This file was deleted.

Binary file removed xmpl/db/content/Broken Solar Panel.jpg
Binary file not shown.
Binary file removed xmpl/db/content/INVERTER FAULT REPORT.pdf
Binary file not shown.
24 changes: 0 additions & 24 deletions xmpl/db/content/Inverter-error-logs.txt

This file was deleted.

Binary file removed xmpl/db/content/No_current.xlsx
Binary file not shown.
Binary file removed xmpl/db/content/Solar Panel Report.pdf
Binary file not shown.
11 changes: 0 additions & 11 deletions xmpl/db/content/strange-noise.csv

This file was deleted.

22 changes: 0 additions & 22 deletions xmpl/db/init.js

This file was deleted.

13 changes: 0 additions & 13 deletions xmpl/package.json

This file was deleted.

1 change: 0 additions & 1 deletion xmpl/srv/service.cds

This file was deleted.