app-tutorial icon indicating copy to clipboard operation
app-tutorial copied to clipboard

Tutorial app which is built in the tutorial

trafficstars

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.