https://github.com/nextcloud/app-tutorial

Tutorial app which is built in the tutorial
https://github.com/nextcloud/app-tutorial

app development frontend hacktoberfest nextcloud php tutorial

Last synced: about 22 hours ago
JSON representation

Tutorial app which is built in the tutorial

• Host: GitHub
• URL: https://github.com/nextcloud/app-tutorial
• Owner: nextcloud
• License: agpl-3.0
• Created: 2017-07-30T08:28:39.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-12-28T02:06:20.000Z (12 days ago)
• Last Synced: 2025-01-01T01:17:33.813Z (8 days ago)
• Topics: app, development, frontend, hacktoberfest, nextcloud, php, tutorial
• Language: PHP
• Homepage:
• Size: 21.6 MB
• Stars: 51
• Watchers: 6
• Forks: 40
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: COPYING

Awesome Lists containing this project

README

        
# Nextcloud App Tutorial

[![PHPUnit GitHub Action](https://github.com/nextcloud/app-tutorial/workflows/PHPUnit/badge.svg)](https://github.com/nextcloud/app-tutorial/actions?query=workflow%3APHPUnit)

[![Node GitHub Action](https://github.com/nextcloud/app-tutorial/workflows/Node/badge.svg)](https://github.com/nextcloud/app-tutorial/actions?query=workflow%3ANode)

[![Lint GitHub Action](https://github.com/nextcloud/app-tutorial/workflows/Lint/badge.svg)](https://github.com/nextcloud/app-tutorial/actions?query=workflow%3ALint)

This is the [tutorial app](https://docs.nextcloud.com/server/latest/developer_manual/app_development/tutorial.html) 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](https://vuejs.org/). 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.