From f8f04f6d5338927e9cec555b8b1bf8c332404ea1 Mon Sep 17 00:00:00 2001 From: guerler Date: Sat, 26 Oct 2024 12:41:56 +0300 Subject: [PATCH] Update installation guide --- docs/content/installation.md | 38 +++++++++++++++++++++++++++++------- 1 file changed, 31 insertions(+), 7 deletions(-) diff --git a/docs/content/installation.md b/docs/content/installation.md index dc56436..00ea521 100644 --- a/docs/content/installation.md +++ b/docs/content/installation.md @@ -1,20 +1,44 @@ # Installation -The Galaxy Charts environment is available as Vue3 Library and can be installed through the node package manager. +To get started, we recommend cloning the [Galaxy Visualizations repository](https://github.com/galaxyproject/galaxy-visualizations). While cloning this repository isn't strictly necessary to add new visualizations to Galaxy, it's best practice to keep a central collection of all visualizations here for easy access and management. -## Install Galaxy Charts +Run the following command to clone the Galaxy Visualizations repsoitory: +```md +git clone https://github.com/galaxyproject/galaxy-visualizations +``` -Click here to visit npm and access the package details. +Once cloned, navigate to the packages subdirectory. This is where we will add a new visualization. +```md +cd galaxy-visualizations/packages +``` + +Ensure the degit tool is installed. ```md -npm install galaxy-charts +npm install -g degit ``` +Then use it to copy the `galaxy-charts-starter` kit, specifying the desired name for your visualization or plugin. -**Alternatively, you may clone the Galaxy Charts Starter-Kit** +```md +degit https://github.com/guerler/galaxy-charts-starter YOUR_PLUGIN_NAME +``` -The Galaxy Charts Starter-Kit simplifies getting started with your visualization plugin by providing a pre-configured Vite/Vue3 build environment and placeholder files. +Navigate to your newly created plugin directory, and run: ```md -git clone https://github.com/guerler/galaxy-charts-starter +cd YOUR_PLUGIN_NAME +npm install +npm run dev +``` + +Your development environment is now set up and ready for customization! + +## Add to Existing Vue Application + +The Galaxy Charts environment is available as Vue3 Library and can be installed through the node package manager. +Click here to visit npm and access the package details. + +```md +npm install galaxy-charts ```