Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cap-js/docs
CAP Documentation
https://github.com/cap-js/docs
cap cds documentation
Last synced: about 1 month ago
JSON representation
CAP Documentation
- Host: GitHub
- URL: https://github.com/cap-js/docs
- Owner: cap-js
- License: apache-2.0
- Created: 2023-03-03T09:19:46.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T09:33:26.000Z (about 2 months ago)
- Last Synced: 2024-10-29T09:52:26.009Z (about 2 months ago)
- Topics: cap, cds, documentation
- Language: Vue
- Homepage: https://cap.cloud.sap
- Size: 16.8 MB
- Stars: 47
- Watchers: 16
- Forks: 99
- Open Issues: 50
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Documentation for
SAP Cloud Application Programming Model
[](https://api.reuse.software/info/github.com/cap-js/docs)
## About this project
This repository contains the core parts of the **documentation pages** for the SAP Cloud Application Programming Model. As a short name, we refer to the documentation as _Capire_.
Along with additional SAP-specific pages the content is published to https://cap.cloud.sap on a regular basis.
## Support, Feedback, Contributing
This project is open to feature requests/suggestions, bug reports, etc. via [GitHub issues](https://github.com/cap-js/docs/issues) and [pull requests](https://github.com/cap-js/docs/pulls). Contribution and feedback are encouraged and always welcome.
See our [contribution guidelines](CONTRIBUTING.md) for information about how to contribute, the project structure, as well as additional contribution information.
## Running Locally
If you contribute often to the documentation it's best to create your own fork, clone it to your local machine.
```sh
git clone https://github.com/cap-js/docs # or whatever your fork's URL is
```
Install the dependencies:
```sh
npm run setup
```
Start the local server:
```sh
npm run start
```
This will respond with:
```
vitepress v1...
➜ Local: http://localhost:5173/docs/
➜ Network: use --host to expose
➜ press h to show help
```
Once this is running, if you are reading this documentation at https://cap.cloud.sap/,
- press l to open the page on _localhost_
- and then press o to open the page in your local VS Code
## Code of Conduct
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md) at all times.
## Licensing
Copyright 2023-2024 SAP SE or an SAP affiliate company and CAP contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/cap-js/docs).