Setting up a development environment and running for development
Setting up Nextcloud server for development
First a nextcloud server is needed to run the app within.
There are multiple methods to set up the Nextcloud development environment.
:warning: DO NOT USE THIS IN PRODUCTION Various settings in this setup are considered insecure and default passwords and secrets are used all over the place.
- By default, you can use this Docker Compose configuration. This method is easier in that you don’t have to manually install Nextcloud, a SQL database, etc.
Follow the instructions in this repository, noting that the default username/password are admin/admin. - Alternatively, the official guide walks you through installing Nextcloud and its dependencies on bare metal.
Add Cookbook to your Nextcloud environment’s apps directory
You must install the checked out version of the app into the corresponding folder of the nextcloud server.
Usage of nextcloud-docker-dev by juliushaertl (Default)
If you installed via Docker, the volumes section of the docker-compose.yml shows that there are many options for specifying apps.
Just go with the documentation attached in the repository and follow the steps. This should bring you to a running environment.
Bare metal installation
If you installed on bare metal (directly in the operating system’s HTTP server):
cd /var/www/nextcloud/apps
git clone https://github.com/nextcloud/cookbook.git # you may want to clone your own fork if you are contributing pull requests
Install PHP dependencies
The app needs some dependencies in the PHP backend. These are managed via composer. Make sure, you have composer ready on your development machine.
To install the required packages just run in the root of the checked-out source folder of the cookbook app
composer install
This will download all required PHP packages into the vendor folder.
If you need to reset for some reason after having broken things, remove the vendor folder and the composer.lock file only from the source code of the cookbook app. Then, you can install the PHP dependencies from scratch.
Download NPM dependencies
The frontend is based on Vue. Some Javascript/NPM dependencies are needed in order to build the frontend from the source code. Make sure you have a matching node.js version installed and make sure npm is present on your machine.
Open a terminal to the directory where you cloned the cookbook app. Then download the dependencies with:
npm ci
Create the bundled assets for the frontend
Use the NPM script to prepare the Webpack bundle:
npm run build-dev
Alternatively, you can create a incremental watcher while programming. This will rebuild as soon as you save any of the *.vue files. You can do this by
npm run dev
Enable the app
By default, the Cookbook app will be disabled. You need to make sure the app is enabled in the NC server. You can use the occ interface if you have access.
Alternatively, open the Nextcloud web interface and login. Click your avatar, then Apps. Find the cookbook app and click on Enable.