Skip to content

Getting Started

Follow these steps to start developing a new visualization for Galaxy.

1. Set Up Your Repository

  1. Sign in to your GitHub account.
  2. Go to the Galaxy Charts Starter repository.
  3. Click on Use this template and select Create a new repository.
  4. Name your new repository (e.g., MY_VISUALIZATION), then complete the setup by clicking Create repository.

2. Clone Your Repository

Open a terminal window and clone your newly created repository:

bash
git clone https://github.com/USERNAME/MY_VISUALIZATION

Replace USERNAME with your GitHub username and MY_VISUALIZATION with your repository name.

3. Initialize Your Visualization Project

Navigate to your project directory and set up the environment:

bash
cd MY_VISUALIZATION
npm install
npm run dev

4. Next Steps

Open a web browser and navigate to the localhost URL displayed in your terminal (typically in the format http://localhost:PORT):

starter

🎉 Congratulations!

Your Galaxy visualization repository is set up and ready for development. Follow the instructions on the splash screen and refer to these docs as you build your custom visualization.

When you’re ready to publish, refer to the Deploy to Galaxy section to share your visualization with the Galaxy community.

Thank you for your contribution!