Skip to content

README.md

Latest commit

 

History

History
121 lines (78 loc) · 4.88 KB

README.md

File metadata and controls

121 lines (78 loc) · 4.88 KB

Slack workspace EPLv2 License Build Status OpenSSF Scorecard

open-vsx.org

This repository contains the source of open-vsx.org, the public instance of Eclipse Open VSX. Most of the code is maintained in eclipse/openvsx, while here you'll find only adaptations specific to the public instance.

The main artifact is the Docker image available at ghcr.io/eclipsefdn/openvsx-website. It contains the server application with customized frontend and base configuration.

Publishing and Managing Extensions

For information on publishing and managing extensions at open-vsx.org, please see the open-vsx.org wiki.

Claiming Namespace Ownership

Open VSX namespaces are public by default. Create an issue here to claim ownership of a namespace.

If you want to refute a previously granted ownership, please comment on the corresponding issue.

Getting Started

Prerequisites

  • Node.js 22.0.0 or higher
  • Yarn 4.9.1 (managed via Corepack)

Local Development Setup

  1. Navigate to the website directory and enable Yarn:
cd website
corepack enable
corepack prepare yarn@stable --activate
  1. Install dependencies and build the project:
yarn install
yarn build
  1. Start the development server:
yarn dev

The development server will be available at http://localhost:5173 (default Vite port).

Available Scripts

  • yarn build - Build the production-ready website
  • yarn dev - Start the development server with hot reload
  • yarn preview - Preview the production build locally
  • yarn lint - Check code quality with ESLint and Prettier
  • yarn format - Auto-format code with Prettier

Deployment

This project uses Kubernetes and Helm for deployment. See kubernetes/README.md for detailed deployment instructions.

Contributing

We welcome contributions! Here's how to get started:

  1. Fork the eclipsefdn/open-vsx.org repository
  2. Clone your fork: git clone https://github.com/[your_github_username]/open-vsx.org.git
  3. Create a feature branch: git checkout -b my-new-feature
  4. Make your changes and test locally
  5. Commit with sign-off: git commit -m 'Add some feature' -s
  6. Push to your fork: git push origin my-new-feature
  7. Submit a pull request

Code Quality

Before submitting a PR, ensure your code passes linting:

cd website
yarn lint

Commit Sign-off

All commits must be signed off (-s flag) to certify that you have the right to submit the code under the project's license.

Declared Project Licenses

This program and the accompanying materials are made available under the terms of the Eclipse Public License v. 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

SPDX-License-Identifier: EPL-2.0

Bugs and feature requests

Have a bug or a feature request? Please search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Trademarks

  • Eclipse® is a Trademark of the Eclipse Foundation, Inc.
  • Eclipse Foundation is a Trademark of the Eclipse Foundation, Inc.

Copyright and license

Copyright 2021-2025 the Eclipse Foundation, Inc. and the open-vsx.org authors. Code released under the Eclipse Public License Version 2.0 (EPL-2.0).