Skip to content

docs: Add development setup steps to readme #1094

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CarlSchwan merged 1 commit into from
Apr 30, 2026
+10 −0
Merged

docs: Add development setup steps to readme #1094

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,13 @@ The following providers are supported and tested at the moment:
- Any other provider that authenticates using the environment variable

While theoretically any other authentication provider implementing either one of those standards is compatible, we like to note that they are **not** part of any internal test matrix.


## 🚧 Development setup

1. Simply clone this repository into the `apps` folder of your Nextcloud development instance.
2. Run `composer install` to install PHP dependencies.
3. Run `npm ci` to install JS/frontend dependencies.
4. Run `npm run build` for a production build or `npm run watch` for a watch/dev build.
5. Then activate the app through the apps management.
6. Make sure to configure the app in "SSO & SAML authentication" in administration settings.
Loading