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

https://github.com/cardinal-run/get.cardinal.run

Source code for the installer script used by Cardinal.run
https://github.com/cardinal-run/get.cardinal.run

installer installer-script

Last synced: 6 months ago
JSON representation

Source code for the installer script used by Cardinal.run

Awesome Lists containing this project

README

          


get.cardinal.run

[![build](https://github.com/cardinal-run/get.cardinal.run/actions/workflows/main.yaml/badge.svg)](https://github.com/cardinal-run/get.cardinal.run/actions/workflows/main.yaml)
[![coverage](https://raw.githubusercontent.com/cardinal-run/get.cardinal.run/main/coverage_badge.svg)](https://github.com/cardinal-run/get.cardinal.run/actions/workflows/main.yaml)
[![License: MIT](https://img.shields.io/badge/license-MIT-purple.svg)](https://opensource.org/licenses/MIT)

This repository is the source code of the utility script that allows developers to easily add the Cardinal SDK to their existing projects.

It runs as a Cloudflare worker that, depending on the user agent, will output a Shell script that can be ran on the developer's machine.

## 🚀 Quick Start

To get started with using Cardinal, sign up for a Cardinal account via the [Dashboard](https://app.cardinal.run) and create your account.

> **Note**: Cardinal is currently in closed alpha and sign-up is invite-only.

Once you have created your account, you can use this installer to add the Cardinal SDK as a dependency to your project:

```shell
curl -fsSL https://get.cardinal.run | sh
```

## 🤝 Community

Got questions? Join our [Discord server](https://discord.gg/Abkm7Ewhen) and let us know how we can help!

## 📃 License

The installer is open source and available under the MIT license, see the [LICENSE](LICENSE) for more information.

---

Thanks to everyone who has contributed to the installer!