fix #6
This commit is contained in:
		
							
								
								
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1 @@
 | 
				
			|||||||
 | 
					.idea
 | 
				
			||||||
							
								
								
									
										68
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										68
									
								
								README.md
									
									
									
									
									
								
							@@ -5,69 +5,15 @@
 | 
				
			|||||||

 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## 
 | 
					## Install
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Place this app in **nextcloud/apps/**
 | 
					Place this app in **nextcloud/apps/**
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Building the app
 | 
					## ⚠️ Warnings ⚠️
 | 
				
			||||||
 | 
					
 | 
				
			||||||
The app can be built by using the provided Makefile by running:
 | 
					- The application is not a real interactive terminal and does not support long running tasks. 
 | 
				
			||||||
 | 
					So if your instance is pretty big, commands like `occ files:scan` will time out and fail.
 | 
				
			||||||
 | 
					- Do not use `occ maintenance:mode -on`, obvious...
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    make
 | 
					## TODOs:
 | 
				
			||||||
 | 
					See [open issues](https://git.adphi.net/Adphi/OCCWeb/issues)
 | 
				
			||||||
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**:
 | 
					 | 
				
			||||||
```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](http://apps.nextcloud.com/) 
 | 
					 | 
				
			||||||
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](http://phpunit.de/getting-started.html) and use the 
 | 
					 | 
				
			||||||
configurations directly:
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    phpunit -c phpunit.xml
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
or:
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    phpunit -c phpunit.integration.xml
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
for integration tests
 | 
					 | 
				
			||||||
 
 | 
				
			|||||||
@@ -30,7 +30,7 @@ class OccOutput extends BufferedOutput implements ConsoleOutputInterface
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
  }
 | 
					  }
 | 
				
			||||||
 | 
					
 | 
				
			||||||
  public function __call($name, $arguments) {
 | 
					//  public function __call($name, $arguments) {
 | 
				
			||||||
    // TODO: Implement @method ConsoleSectionOutput section()
 | 
					//    // TODO: Implement @method ConsoleSectionOutput section()
 | 
				
			||||||
  }
 | 
					//  }
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user