diff --git a/Makefile b/Makefile deleted file mode 100644 index 6541f63ba..000000000 --- a/Makefile +++ /dev/null @@ -1,70 +0,0 @@ -# This file is licensed under the Affero General Public License version 3 or -# later. See the COPYING file. - -all: dev-setup lint build-js-production test test-php - -# Dev env management -dev-setup: composer-install clean npm-init - -npm-init: - npm ci - -composer-init: - composer install --prefer-dist - composer update --prefer-dist - -composer-install: - composer install --prefer-dist - -npm-update: - npm update - -# Building -build-js: - npm run dev - -build-js-production: - npm run build - -watch-js: - npm run watch - -# Testing -test: - npm run test - -test-watch: - npm run test:watch - -test-coverage: - npm run test:coverage - -test-php: - phpunit -c phpunit.xml - phpunit -c phpunit.integration.xml - -test-php-coverage: - phpunit -c phpunit.xml --coverage-clover=coverage-unit.xml - phpunit -c phpunit.integration.xml --coverage-clover=coverage-integration.xml - -# Linting -lint: - npm run lint - -lint-fix: - npm run lint:fix - -# Style linting -stylelint: - npm run stylelint - -stylelint-fix: - npm run stylelint:fix - -# Cleaning -clean: - rm -rf js - -# Builds the source package for the app store, ignores php and js tests -appstore: - krankerl package diff --git a/README.md b/README.md index 58e0538f1..eacd48235 100644 --- a/README.md +++ b/README.md @@ -47,30 +47,28 @@ If you find bugs or have problems with the CalDAV-Backend, you should ask the te ## Build the app -Make sure you have all the [necessary prerequisites](https://docs.nextcloud.com/server/latest/admin_manual/installation/source_installation.html#prerequisites-for-manual-installation) for manual installs +General build instructions for the app itself are the same for all options. -``` bash -# set up and build for production -make +To build you will need to have [Node.js](https://nodejs.org/en/) and +[Composer](https://getcomposer.org/) installed. -# install dependencies -make dev-setup +- Install PHP dependencies: `composer install --no-dev` +- Install JS dependencies: `npm ci` +- Build JavaScript for the frontend + - Development build `npm run dev` + - Watch for changes `npm run watch` + - Production build `npm run build` -# build for dev and watch changes -make watch-js +Read more about [necessary prerequisites](https://docs.nextcloud.com/server/latest/admin_manual/installation/source_installation.html#prerequisites-for-manual-installation) for manual installs -# build for dev -make build-js -# build for production with minification -make build-js-production - -``` ## Running tests -You can use the provided Makefile to run all tests by using: + +You can run the following back-end and front-end tests by using: ``` -make test +composer test +npm run test ``` ## :v: Code of conduct