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 d55daa3
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ export default defineConfig({
text: 'Getting Started',
items: [
{ text: 'What is Galaxy Charts?', link: '/content/introduction' },
{ text: 'Examples', link: '/content/examples' },
{ text: 'Installation', link: '/content/installation' },
{ text: 'Connect to Galaxy Instance', link: '/content/configuration' },
{ text: 'Examples', link: '/content/examples' },
]
},
{
Expand Down
40 changes: 32 additions & 8 deletions docs/content/installation.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,44 @@
# Installation
# Adding New Visualizations to Galaxy

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](https://github.com/guerler/galaxy-charts-starter) kit, specifying the desired name for your visualization plugin.

**Alternatively, you may clone the Galaxy Charts Starter-Kit**
```md
degit https://github.com/guerler/galaxy-charts-starter MY_VISUALIZATION
```

The Galaxy Charts Starter-Kit simplifies getting started with your visualization plugin by providing a pre-configured Vite/Vue3 build environment and placeholder files.
Now is the right time to create your own github feature branch containing your visualization.

```md
git clone https://github.com/guerler/galaxy-charts-starter
git checkout -b MY_BRANCH
git add MY_VISUALIZATION
```

Navigate to your newly created plugin directory, and run:

```md
cd MY_VISUALIZATION
npm install
npm run dev
```

Your development environment is now set up and ready for customization!

Once you have completed adding your visualization or properly embedding a 3rd party plugin for integration with Galaxy, continue by pushing your changes to [github](https://docs.github.com) and issue a pull request.

0 comments on commit d55daa3

Please sign in to comment.