Nextcloud-App/README.md
Ben 23e4f0c974
Fix run script, replace registration secret
add watch-js to README.md to start the dev environment.
2021-10-09 19:04:23 +02:00

46 lines
1.6 KiB
Markdown

# UPschooling
Place this app in **nextcloud/apps/**
[![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.
## Development
Docker or Podman is required for the dev environment.
Other than that composer and npm/nodejs must be installed.
### Mac OS
```shell
brew install coreutils
```
### All
```shell
npm install
make
```
### Start dev environment
Starting the development environment with your container runtime should be as easy as
```shell
./run.sh
make watch-js
```
## 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.