canonical/charmhub.io

charmhub.io codebase

Python Coverage | JavaScript Coverage

A charm is a software package that bundles an operator together with metadata that supports the integration of many operators in a coherent aggregated system.

An operator packaged as a charm means that it is configured, operated and integrated in a standard way regardless of the vendor or the application. Charms enable multi-vendor operator collections with standardised behaviours, reducing the learning curve associated with each operator and creating richer application ecosystems.

This repo is the application for the charmhub.io website.

The site is largely maintained by the Web and Design team at Canonical. It is a stateless website project based on Flask and hosted on a Charmed Kubernetes cluster.

Bugs and issues

If you have found a bug on the site or have an idea for a new feature, feel free to create a new issue, or suggest a fix by creating a pull request. You can also find a link to create issues in the footer of every page of the site itself.

Local development

The simplest way to run the site locally is using dotrun:

dotrun

Once the server has started, you can visit http://127.0.0.1:8045 in your browser. You can stop the server using <ctrl>+c.

For more detailed local development instructions, see HACKING.md.

License

The content of this project is licensed under the Creative Commons Attribution-ShareAlike 4.0 International license, and the underlying code used to format and display that content is licensed under the LGPLv3 by Canonical Ltd.

With ♥ from Canonical