adphi/occweb
1
0
Fork 2
Code Issues Pull Requests 1 Releases 4 Wiki Activity

Updated README.md

Browse Source
This commit is contained in:
Adphi 2019-01-19 21:00:53 +01:00
parent 1745aa185a
commit 8c4d675e1f
1 changed files with 26 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -1,4 +1,8 @@
# Test Nextcloud App # OCCWeb terminal
A web terminal for admins to launch Nextcloud's occ commands
Place this app in **nextcloud/apps/** Place this app in **nextcloud/apps/**
## Building the app ## Building the app
@ -11,16 +15,24 @@ This requires the following things to be present:
* make * make
* which * which
* tar: for building the archive * tar: for building the archive
* curl: used if phpunit and composer are not installed to fetch them from the web * curl: used if phpunit and composer are not installed to fetch them
* npm: for building and testing everything JS, only required if a package.json is placed inside the **js/** folder 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.: 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**: **package.json**:
```json ```json
"scripts": { "scripts": {
"test": "node node_modules/gulp-cli/bin/gulp.js karma", "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", "prebuild": "npm install && node_modules/bower/bin/bower install &&
node_modules/bower/bin/bower update",
"build": "node node_modules/gulp-cli/bin/gulp.js" "build": "node node_modules/gulp-cli/bin/gulp.js"
} }
``` ```
@ -28,20 +40,25 @@ The make command will install or update Composer dependencies if a composer.json
## Publish to App Store ## Publish to App Store
First get an account for the [App Store](http://apps.nextcloud.com/) then run: First get an account for the [App Store](http://apps.nextcloud.com/)
then run:
make && make appstore make && make appstore
The archive is located in build/artifacts/appstore and can then be uploaded to the App Store. The archive is located in build/artifacts/appstore and can then be
uploaded to the App Store.
## Running tests ## Running tests
You can use the provided Makefile to run all tests by using: You can use the provided Makefile to run all tests by using:
make test 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** 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](http://phpunit.de/getting-started.html) and use the configurations directly: Of course you can also install
[PHPUnit](http://phpunit.de/getting-started.html) and use the
configurations directly:
phpunit -c phpunit.xml phpunit -c phpunit.xml