Update README.md
Browse files
README.md
CHANGED
|
@@ -2,67 +2,10 @@
|
|
| 2 |
title: Webvowl
|
| 3 |
emoji: π
|
| 4 |
short_description: Hosting of Webovwl
|
| 5 |
-
sdk:
|
| 6 |
pinned: false
|
| 7 |
---
|
| 8 |
|
| 9 |
---
|
| 10 |
WebVOWL [](https://travis-ci.org/VisualDataWeb/WebVOWL)
|
| 11 |
=======
|
| 12 |
-
|
| 13 |
-
> [!CAUTION]
|
| 14 |
-
> The URL https://visualdataweb.org/ is not owned bei VisualDataWeb anymore! Not related to WebVOWL anymore.
|
| 15 |
-
|
| 16 |
-
This repository was ported from an internal SVN repository to Github after the release of WebVOWL 0.4.0. Due to cleanups with `git filter-branch`, the commit history might show some strange effects.
|
| 17 |
-
|
| 18 |
-
Run Using Docker
|
| 19 |
-
------------
|
| 20 |
-
Make sure you are inside `WebVOWL` directory and you have docker installed. Run the following command to build the docker image:
|
| 21 |
-
|
| 22 |
-
`docker build . -t webvowl:v1`
|
| 23 |
-
|
| 24 |
-
Run the following command to run WebVOWL at port 8080.
|
| 25 |
-
|
| 26 |
-
`docker-compose up -d`
|
| 27 |
-
|
| 28 |
-
Visit [http://localhost:8080](http://localhost:8080) to use WebVOWL.
|
| 29 |
-
|
| 30 |
-
Requirements
|
| 31 |
-
------------
|
| 32 |
-
|
| 33 |
-
Node.js for installing the development tools and dependencies.
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
Development setup
|
| 37 |
-
-----------------
|
| 38 |
-
|
| 39 |
-
### Simple ###
|
| 40 |
-
1. Download and install Node.js from http://nodejs.org/download/
|
| 41 |
-
2. Open the terminal in the root directory
|
| 42 |
-
3. Run `npm install` to install the dependencies and build the project
|
| 43 |
-
4. Edit the code
|
| 44 |
-
5. Run `npm run-script release` to (re-)build all necessary files into the deploy directory
|
| 45 |
-
6. Run `serve deploy/` to run the server locally, by installing serve by using `npm install serve -g`.
|
| 46 |
-
|
| 47 |
-
Visit [http://localhost:3000](http://localhost:3000) to use WebVOWL.
|
| 48 |
-
|
| 49 |
-
### Advanced ###
|
| 50 |
-
Instead of the last step of the simple setup, install the npm package `grunt-cli` globally with
|
| 51 |
-
`npm install grunt-cli -g`. Now you can execute a few more advanced commands in the terminal:
|
| 52 |
-
|
| 53 |
-
* `grunt` or `grunt release` builds the release files into the deploy directory
|
| 54 |
-
* `grunt package` builds the development version
|
| 55 |
-
* `grunt webserver` starts a local live-updating webserver with the current development version
|
| 56 |
-
* `grunt test` starts the test runner
|
| 57 |
-
* `grunt zip` builds the project and puts it into a zip file
|
| 58 |
-
|
| 59 |
-
|
| 60 |
-
Additional information
|
| 61 |
-
----------------------
|
| 62 |
-
|
| 63 |
-
To export the VOWL visualization to an SVG image, all css styles have to be included into the SVG code.
|
| 64 |
-
This means that if you change the CSS code in the `vowl.css` file, you also have to update the code that
|
| 65 |
-
inlines the styles - otherwise the exported SVG will not look the same as the displayed graph.
|
| 66 |
-
|
| 67 |
-
The tool which creates the code that inlines the styles can be found in the util directory. Please
|
| 68 |
-
follow the instructions in its [README](util/VowlCssToD3RuleConverter/README.md) file.
|
|
|
|
| 2 |
title: Webvowl
|
| 3 |
emoji: π
|
| 4 |
short_description: Hosting of Webovwl
|
| 5 |
+
sdk: docker
|
| 6 |
pinned: false
|
| 7 |
---
|
| 8 |
|
| 9 |
---
|
| 10 |
WebVOWL [](https://travis-ci.org/VisualDataWeb/WebVOWL)
|
| 11 |
=======
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|