Difference between revisions of "Uploading a new visualisation"

From ImpVis Wiki
Jump to navigation Jump to search
Line 11: Line 11:
This is your '''source code''' '''-''' you cannot simply click on the main HTML file to run the visualisation (instead you normally view your visualisation by running 'npm run serve' in your command prompt). To create the source code zip file, simply zip the entire folder structure and give it the same name as your visualisation.
This is your '''source code''' '''-''' you cannot simply click on the main HTML file to run the visualisation (instead you normally view your visualisation by running 'npm run serve' in your command prompt). To create the source code zip file, simply zip the entire folder structure and give it the same name as your visualisation.


To create the '''visualisation zip file''', you will need to enter the following command in your command prompt (in the same way as you usually run 'npm run serve'):
To create the '''visualisation zip file''', you will need to enter the following command in your command prompt (in the same way as you usually run 'npm run serve'): <center><code>npm run build</code></center>
 
This
<center><code>npm run build</code></center>




https://github.com/ImpVis/lattice-vibrations-introduction
https://github.com/ImpVis/lattice-vibrations-introduction

Revision as of 11:53, 29 September 2021

Files to upload

In order to upload your visualisation, you will need the following files prepared:

  1. Visualisation zip file A single zip file with all your code files and assets, which should contain everything your visualisation needs to run - i.e. the HTML files, JavaScript files and others such as CSS files or images that your visualisation may need. This means that if you click on the main HTML file, your visualisation should open in your browser and be fully functional. Note: all paths to assets and internal links should be relative. Also ensure that if you include any links to other web pages in your files (e.g. dependencies on other packages), you use https links (http links will not work).
  2. Source code zip file (optional) A single zip file with all your source code, if different from the visualisation zip file mentioned above (e.g. if you used the ImpVis template to create your visualisation).
  3. A screenshot image (optional) This image will be displayed on the 'visualisation card' in the 'Teach' environment on the website.

How to prepare your files

If you have built your visualisation with the ImpVis template, initially your file structure may look something like this (see ...):

This is your source code - you cannot simply click on the main HTML file to run the visualisation (instead you normally view your visualisation by running 'npm run serve' in your command prompt). To create the source code zip file, simply zip the entire folder structure and give it the same name as your visualisation.

To create the visualisation zip file, you will need to enter the following command in your command prompt (in the same way as you usually run 'npm run serve'):

npm run build

This


https://github.com/ImpVis/lattice-vibrations-introduction