No description
Find a file
2025-09-30 18:43:20 +00:00
.github ci: update node.yml workflow from template 2025-06-01 11:44:04 +00:00
appinfo chore: bump min to 29 and max to 31 2025-02-13 15:32:26 +01:00
css Update stylelint version 2020-04-22 08:31:03 +02:00
img replace icon 2017-07-30 11:23:07 +02:00
js chore(assets): Recompile assets 2025-08-26 06:29:29 +00:00
lib fix(lint): Fix php-cs-fixer issues detected 2023-01-16 20:39:58 +01:00
src fix: Add missing training comma 2023-02-15 23:05:58 +01:00
templates Fix wrong tutorial location 2020-08-24 14:24:26 +02:00
tests chore: adjust composer 2025-02-13 17:12:32 +01:00
.eslintrc.js Fix deprecations 2020-07-27 10:23:10 +02:00
.gitattributes Add bundles to have a working app after checkout 2019-08-17 18:51:50 +02:00
.gitignore chore(deps): Update nextcloud/coding-standard to version 1.0.0 2023-01-13 13:24:13 +01:00
.php-cs-fixer.dist.php chore(deps): Update nextcloud/coding-standard to version 1.0.0 2023-01-13 13:24:13 +01:00
babel.config.js Update babel config 2021-07-07 10:05:11 +02:00
CHANGELOG.md update files 2017-07-30 11:28:19 +02:00
composer.json chore: adjust composer 2025-02-13 17:12:32 +01:00
composer.lock chore(deps-dev): Bump phpunit/phpunit from 9.5.28 to 9.6.3 2023-02-16 06:47:16 +00:00
COPYING first commit 2015-01-10 00:25:43 +01:00
Makefile Add HMR commands 2021-07-28 13:59:20 +02:00
package-lock.json chore(deps): Bump form-data from 4.0.0 to 4.0.4 2025-09-30 18:42:02 +00:00
package.json build: update node and npm engines versions 2025-08-25 12:43:24 +00:00
README.md fix(docs): Make clear that the app directory has to be named like the app id 2023-01-13 14:37:08 +01:00
stylelint.config.js Bump deps and use npm7 2021-06-11 11:52:22 +02:00
webpack.config.js rename webpack.js to webpack.config.js 2022-01-02 16:01:37 +01:00

Nextcloud App Tutorial

PHPUnit GitHub Action Node GitHub Action Lint GitHub Action

This is the tutorial app which shows how to develop a very simple notes app.

Try it

To install it change into your Nextcloud's apps directory:

cd nextcloud/apps

Then clone this repository into a folder named notestutorial¹:

git clone https://github.com/nextcloud/app-tutorial.git notestutorial

Then install the dependencies using:

make composer

¹ It is important that the directory is named exactly like the app ID (see appinfo/info.xml).

Frontend development

The app tutorial also shows the very basic implementation of an app frontend using Vue.js. To build the frontend code after doing changes to its source in src/ requires to have Node and npm installed.

  • 👩‍💻 Run make dev-setup to install the frontend dependencies
  • 🏗 To build the Javascript whenever you make changes, run make build-js

To continuously run the build when editing source files you can make use of the make watch-js command.