Skip to content

Commit

Permalink
Update installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
guerler committed Oct 26, 2024
1 parent 0a8acb5 commit f8f04f6
Showing 1 changed file with 31 additions and 7 deletions.
38 changes: 31 additions & 7 deletions docs/content/installation.md
Original file line number Diff line number Diff line change
@@ -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
```

<a href="https://www.npmjs.com/package/galaxy-charts">Click here to visit npm and access the package details</a>.
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.
<a href="https://www.npmjs.com/package/galaxy-charts">Click here to visit npm and access the package details</a>.

```md
npm install galaxy-charts
```

0 comments on commit f8f04f6

Please sign in to comment.