Difference between revisions of "Editing ImpVis Components"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
# To edit the components library you must first clone [https://github.com/Imperial-visualizations/Vue-Components the repository]. If you are making a small change then cloning and editing directly on the "dev" branch may work, however if you are making larger changes you may want to consider making your own fork or branch. | |||
* Run “npm run template” to get an example template to view while editing vue components. | # To start editing you must navigate to the folder you have cloned in a command prompt/terminal using "cd <directory path>". Once in the correct location you can run the example template to test your component by running <code>npm run template</code>. The code for this example template is located within the "template" folder. | ||
locally, clone the vue components repository (you may want to create your own fork or branch). | |||
*Run “npm run template” to get an example template to view while editing vue components. | |||
* Make your changes to the components and when ready create a pull request to dev and get two reviews from other people. | * Make your changes to the components and when ready create a pull request to dev and get two reviews from other people. | ||
* Create pull request from dev to master and get approved. (remember to increase package version in package.json) | * Create pull request from dev to master and get approved. (remember to increase package version in package.json) | ||
* Now run “npm update @impvis/components” on existing visualisations to get the latest updates. | *Now run “npm update @impvis/components” on existing visualisations to get the latest updates. | ||
Revision as of 10:14, 28 June 2021
- To edit the components library you must first clone the repository. If you are making a small change then cloning and editing directly on the "dev" branch may work, however if you are making larger changes you may want to consider making your own fork or branch.
- To start editing you must navigate to the folder you have cloned in a command prompt/terminal using "cd <directory path>". Once in the correct location you can run the example template to test your component by running
npm run template. The code for this example template is located within the "template" folder.
locally, clone the vue components repository (you may want to create your own fork or branch).
- Run “npm run template” to get an example template to view while editing vue components.
- Make your changes to the components and when ready create a pull request to dev and get two reviews from other people.
- Create pull request from dev to master and get approved. (remember to increase package version in package.json)
- Now run “npm update @impvis/components” on existing visualisations to get the latest updates.