Reading the repo

Opening the box…

Assembly instructions

nextcloud/server

☁️ Nextcloud server, a safe home for all your data

Node.jsVitePHP#cloud#collaboration#decentralized#design

Difficulty: Easy
Time: about 5 min
Stars: ★ 37,420
Activity: Updated this month
License: AGPL-3.0
Open issues: 3,872
Got it running: Be the first
Looked up: 2 h ago

Saved setup from 2 h ago

Start here

Website ↗nextcloud.comThe project's own site.In the browser ↗Open in GitHub CodespacesThe repo ships a dev container, so nothing to install.

Will it work on my device?

Yes, it runs on macOS

You'll build it yourself with Node.js, PHP.

Checking for

5 steps on macOS

1
Clone the repository
Needs Git: xcode-select --install. The repo uses git submodules, so the clone fetches them too.
```
git clone --recurse-submodules https://github.com/nextcloud/server.git
cd server
```

Install the required runtimes

Node.js ^24.0.0, PHP ^8.3

# needs nvm: brew install nvm (or https://github.com/nvm-sh/nvm)
nvm install 24
brew install php composer

3
Install dependencies
```
npm ci
composer install
```
4
Run it
```
npm run dev
```
5
Run the tests
```
npm test
```

Did you get it running?

No reports for macOS yet.

Still stuck? Get a written guide

Claude reads the 13 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.

Parts list

1×Node.js ^24.0.0runtime
1×PHP ^8.3runtime
1×npm package manager
1×composer package manager

Share this manual

Good to know

Dev Container config found — you can open it in VS Code Dev Containers or GitHub Codespaces for a zero-setup environment.
Makefile has a make dev-setup target — it may automate most of these steps.
Has AGENTS.md — instructions for coding agents. You can open Claude Code (or another agent) in the cloned folder and ask it to do the setup for you.
Nested projects: apps/admin_audit/composer/composer.json, apps/appstore/composer/composer.json, apps/cloud_federation_api/composer/composer.json, apps/comments/composer/composer.json and 11 more

package.json scripts (20)

buildbuild/demi.sh build
postbuildbuild/npm-post-build.sh
devbuild/demi.sh dev
postinstallbuild/demi.sh ci
linteslint --suppressions-location build/eslint-baseline.json --no-error-on-unmatched-pattern ./tests/playwright
postlintbuild/demi.sh lint
lint:fixconcurrently 'npm run lint -- --fix' 'build/demi.sh lint:fix'
playwrightplaywright test --project=default --project=admin-settings
playwright:installplaywright install chromium
playwright:setupplaywright test --project=setup
sasssass --style compressed --load-path core/css core/css/ $(for cssdir in $(find apps -mindepth 2 -maxdepth 2 -name "css"); do if ! $(git check-ignore -q $cssdir); then printf "$cssdir "; fi; done)
sass:iconsnode build/icons.mjs
sass:watchsass --watch --load-path core/css core/css/ $(for cssdir in $(find apps -mindepth 2 -maxdepth 2 -name "css"); do if ! $(git check-ignore -q $cssdir); then printf "$cssdir "; fi; done)
stylelintstylelint $(for appdir in $(ls apps); do if ! $(git check-ignore -q "apps/$appdir"); then printf "'apps/$appdir/**/*.{scss,vue}' "; fi; done) 'core/**/*.{scss,vue}'
stylelint:fixnpm run stylelint -- --fix
testvitest run
test:coveragevitest run --coverage
test:update-snapshotsvitest run --update
test:watchvitest watch
watchbuild/demi.sh --parallel watch

Files we read (13)

.devcontainer/devcontainer.json

.github/CONTRIBUTING.md

.github/workflows/autocheckers.yml

.github/workflows/lint-eslint.yml

.github/workflows/lint-php-cs.yml

.github/workflows/lint-php.yml

.github/workflows/lint-stylelint.yml

.github/workflows/node-test.yml

.gitmodules

Makefile

README.md

composer.json

package.json

Branch master · 14,382 files in the repo

Opening the box…

Start here

Yes, it runs on macOS

5 steps on macOS

Clone the repository

Install the required runtimes

Install dependencies

Run it

Run the tests

Did you get it running?

Still stuck? Get a written guide