An open API service indexing awesome lists of open source software.

https://github.com/charted-dev/charted

📦 Free, open source, and reliable Helm Chart registry made in Rust
https://github.com/charted-dev/charted

axum charted-server helm helm-registry k8s kubernetes rust rustlang

Last synced: about 2 months ago
JSON representation

📦 Free, open source, and reliable Helm Chart registry made in Rust

Awesome Lists containing this project

README

        

Noelware logo

### 🐻‍❄️📦 [`charted-server`] by [Noelware, LLC.]

#### _Open, powerful, and reliable Helm chart registry made in [Rust]._

**charted-server** is a free and open platform that helps host, test, and build [Helm] charts all over the world to any side project to enterprise work. Noelware built this platform to build the cloud that we put our sweat and tears into.

## Installation

### Locally via Git

**Required Tools / Prerequisites**:

- [Rust](https://rust-lang.org)
- [Git](https://git-scm.com)
- 20GB of storage
- 2GB of system RAM

To clone the repository, you can use the `git pull` command:

```shell
# HTTPS
$ git pull https://github.com/charted-dev/charted

# SSH
$ git pull [email protected]:charted-dev/charted
```

Once you cloned the repository, you can `cd` into it and run the `charted` CLI:

```shell
$ cargo cli
```

This will run the actual CLI, to run the server, you will need to use this instead:

```shell
$ cargo server
```

### Docker

> [!IMPORTANT]
> You can checkout the [`charted-dev/self-hosted`] repository for a production ready **charted-server** instance with Docker Compose.

### Kubernetes/Helm

Refer to the [`charted-dev/helm-charts`] repository for more information on how to deploy a **charted-server** instance on Kubernetes.

### Nix/NixOS

The [`nixpkgs-noelware`] repository contains a NixOS module to run a **charted-server** instance:

```nix
{
services.charted = {
enable = true;
statePath = "/var/lib/noelware/charted/data";

settings = {
single_user = true;
sessions.backend.static = {
noel = "";
};
};
};
}
```

## Contributing

Thanks for considering contributing to **charted-server**! Before you boop your heart out on your keyboard ✧ ─=≡Σ((( つ•̀ω•́)つ, we recommend you to do the following:

- Read the [Code of Conduct](./.github/CODE_OF_CONDUCT.md)
- Read the [Contributing Guide](./.github/CONTRIBUTING.md)

If you read both if you're a new time contributor, now you can do the following:

- [Fork me! *\*♡( ⁎ᵕᴗᵕ⁎ )](https://github.com/charted-dev/charted/fork)
- Clone your fork on your machine: `git clone https://github.com/your-username/charted`
- Create a new branch: `git checkout -b some-branch-name`
- BOOP THAT KEYBOARD!!!! ♡┉ˏ͛ (❛ 〰 ❛)ˊˎ┉♡
- Commit your changes onto your branch: `git commit -am "add features (。>‿‿<。 )"`
- Push it to the fork you created: `git push -u origin some-branch-name`
- Submit a Pull Request and then cry! 。・゚゚・(థ Д థ。)・゚゚・。

## License

**charted-server** by [Noelware, LLC.] is released under the **Apache 2.0** License with love and care by the team. Please read the [`LICENSE`](/LICENSE) file in the canonical repository for more information on what you can do with the source code for **charted-server**.

[`charted-dev/helm-charts`]: https://github.com/charted-dev/helm-charts
[`charted-dev/self-hosted`]: https://github.com/charted-dev/self-hosted
[`nixpkgs-noelware`]: https://github.com/Noelware/nixpkgs-noelware
[`charted-server`]: https://charts.noelware.org/
[Noelware, LLC.]: https://noelware.org
[Helm]: https://helm.sh
[Rust]: https://rustlang.org