Go to file
Michel Roux b8986ece99
books / xml (push) Successful in 40s Details
books / php (push) Successful in 34s Details
books / nodejs (push) Successful in 1m35s Details
books / release (push) Has been skipped Details
Merge pull request 'chore(deps): update dependency psalm/phar to v5.22.2' (#15) from renovate/psalm-phar-5.x-lockfile into main
Reviewed-on: #15
2024-02-23 09:31:49 +00:00
.gitea/workflows chore(deps): update skjnldsv/read-package-engines-version-actions action to v3 2024-02-03 06:38:55 +00:00
LICENSES exemple app 2023-09-13 16:48:11 +02:00
appinfo feat: register file action 2024-02-06 23:28:17 +01:00
lib feat: register file action 2024-02-06 23:28:17 +01:00
src feat: register file action 2024-02-06 23:28:17 +01:00
templates Remove spdx and github actions 2023-09-13 16:54:18 +02:00
.dockerignore refacto: Use repod framework to the base of books 2024-01-31 00:40:01 +01:00
.eslintignore refacto: Use repod framework to the base of books 2024-01-31 00:40:01 +01:00
.eslintrc.js refacto: Use repod framework to the base of books 2024-01-31 00:40:01 +01:00
.gitattributes Remove spdx and github actions 2023-09-13 16:54:18 +02:00
.gitignore refacto: Use repod framework to the base of books 2024-01-31 00:40:01 +01:00
.l10nignore refacto: Use repod framework to the base of books 2024-01-31 00:40:01 +01:00
.php-cs-fixer.dist.php feat: previews 2024-02-05 23:13:19 +01:00
CHANGELOG.md refacto: Use repod framework to the base of books 2024-01-31 00:40:01 +01:00
Dockerfile refacto: Use repod framework to the base of books 2024-01-31 00:40:01 +01:00
Makefile fix: do not exclude vcs for tar release 2024-02-05 23:49:02 +01:00
README.md Remove spdx and github actions 2023-09-13 16:54:18 +02:00
babel.config.js Remove spdx and github actions 2023-09-13 16:54:18 +02:00
composer.json feat: previews 2024-02-05 23:13:19 +01:00
composer.lock chore(deps): update dependency psalm/phar to v5.22.2 2024-02-23 06:47:43 +00:00
package-lock.json chore(deps): update dependency @nextcloud/dialogs to v5.1.2 2024-02-23 06:47:21 +00:00
package.json feat: register file action 2024-02-06 23:28:17 +01:00
psalm.xml feat: previews 2024-02-05 23:13:19 +01:00
renovate.json Add renovate.json 2023-09-14 06:49:36 +00:00
stylelint.config.js Remove spdx and github actions 2023-09-13 16:54:18 +02:00
webpack.config.js feat: register file action 2024-02-06 23:28:17 +01:00

README.md

Books

Place this app in nextcloud/apps/

Building the app

The app can be built by using the provided Makefile by running:

make

This requires the following things to be present:

  • make
  • which
  • tar: for building the archive
  • curl: used if phpunit and composer are not installed to fetch them from the web
  • npm: for building and testing everything JS, only required if a package.json is placed inside the js/ folder

The make command will install or update Composer dependencies if a composer.json is present and also npm run build if a package.json is present in the js/ folder. The npm build script should use local paths for build systems and package managers, so people that simply want to build the app won't need to install npm libraries globally, e.g.:

package.json:

"scripts": {
    "test": "node node_modules/gulp-cli/bin/gulp.js karma",
    "prebuild": "npm install && node_modules/bower/bin/bower install && node_modules/bower/bin/bower update",
    "build": "node node_modules/gulp-cli/bin/gulp.js"
}

Publish to App Store

First get an account for the App Store then run:

make && make appstore

The archive is located in build/artifacts/appstore and can then be uploaded to the App Store.

Running tests

You can use the provided Makefile to run all tests by using:

make test

This will run the PHP unit and integration tests and if a package.json is present in the js/ folder will execute npm run test

Of course you can also install PHPUnit and use the configurations directly:

phpunit -c phpunit.xml

or:

phpunit -c phpunit.integration.xml

for integration tests