Browse Source

update README, add gitignore for tests

Domenic Horner 2 years ago
parent
commit
ce830eb1d5
2 changed files with 19 additions and 2 deletions
  1. 1 0
      .gitignore
  2. 18 2
      README.md

+ 1 - 0
.gitignore

@@ -0,0 +1 @@
+test/node_modules/

+ 18 - 2
README.md

@@ -1,6 +1,9 @@
 # Redash on Cloudron
 
-Connect to any data source, easily visualize and share your data.
+Make Your Company Data Driven
+Connect to any data source, easily visualize and share your data
+
+This repository packages the Cloudron setup code for [Redash](https://redash.io/)
 
 ## Installation
 
@@ -23,6 +26,19 @@ cloudron build
 cloudron install
 ```
 
+## Testing
+
+The e2e tests are located in the test/ folder and require nodejs.
+They are creating a fresh build, install the app on your Cloudron, perform tests, backup, restore and test if the pages are still ok.
+
+```
+cd Redash-Cloudron/test
+
+npm install
+USERNAME=<cloudron username> PASSWORD=<cloudron password> mocha --bail test.js
+```
+
 ## Usage
 
-Once the Cloudron has started, visit the web ui to create your admin user.
+Once the Cloudron has started, visit the Web Interface to create your admin user.
+