KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #codex #typescript #ai-agents #ai-agent #cli #claude-code #open-source #deepseek-harness #dsh-plugin #python #mcp

chorizo

★ 9 Open GitHub ↗

A versatile, firebase hosted, open-source platform for interactive course management and learning experiences. Tailored for small-group instruction across various disciplines.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
    <img src="apps/course/src/assets/logo.png" width="250" height="250" alt="Chorizo Logo">
    <h1>Chorizo</h1>
    <p>A self-hosted course management platform. Manage courses, create entry lists, and share downloadable resources seamlessly. Fully dynamic and tailored for streamlined administration.</p>
</div>

![NPM Version](https://img.shields.io/npm/v/%40chorizo%2Fcli?style=flat&label=%40chorizo%2Fcli&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40chorizo%2Fcli)
![NPM @chorizo/course Version](https://img.shields.io/npm/v/%40chorizo%2Fcourse?style=flat&label=%40chorizo%2Fcourse)
![NPM Version](https://img.shields.io/npm/v/%40chorizo%2Fadminui?style=flat&label=%40chorizo%2Fadminui)

[![Chorizo](https://img.shields.io/badge/Chorizo-ea8634?logo=github)](https://github.com/danieljancar/chorizo)
[![Mockups - Figma](https://img.shields.io/badge/Mockups-Figma-e36631?logo=figma&logoColor=e36631)](https://www.figma.com/file/oarKaGgevt8SQNcB2w4Lbr/Mockups?type=design&mode=design&t=CBVvajzXHWh5z6Gf-1)
[![issues - chorizo](https://img.shields.io/github/issues/danieljancar/chorizo)](https://github.com/danieljancar/chorizo/issues)
[![License](https://img.shields.io/badge/License-MIT-blue)](https://raw.githubusercontent.com/danieljancar/chorizo/develop/)

[![Linter](https://github.com/danieljancar/chorizo/actions/workflows/lint.yml/badge.svg)](https://github.com/danieljancar/chorizo/actions/workflows/lint.yml)
[![Triage Labeler](https://github.com/danieljancar/chorizo/actions/workflows/triager.yml/badge.svg?event=issues)](https://github.com/danieljancar/chorizo/actions/workflows/triager.yml)
[![Formatting](https://github.com/danieljancar/chorizo/actions/workflows/format.yml/badge.svg)](https://github.com/danieljancar/chorizo/actions/workflows/format.yml)

[![Monorepo Release](https://github.com/danieljancar/chorizo/actions/workflows/release.yml/badge.svg)](https://github.com/danieljancar/chorizo/actions/workflows/release.yml)
[![Deploy latest develop changes](https://github.com/danieljancar/chorizo/actions/workflows/dev-deploy.yml/badge.svg)](https://github.com/danieljancar/chorizo/actions/workflows/dev-deploy.yml)

[![Angular](https://img.shields.io/badge/Angular-c3012f?logo=angular)](https://angular.dev)
[![TailwindCSS](https://img.shields.io/badge/TailwindCSS-ffffff?logo=tailwindcss)](https://tailwindcss.com/)
[![Typescript](https://img.shields.io/badge/Typescript-ffffff?logo=typescript)](https://www.typescriptlang.org/)
[![Firebase](https://img.shields.io/badge/Firebase-ffffff?logo=firebase)](https://firebase.google.com/)

</div>

---

# ⚠️ Notice ⚠️

Still has to be worked on:

- Data-Security (Firebase Rules)
- CLI for instance setup
- Tests

**NOT PRODCUTION READY, RELEASE WILL BE ANNOUNCED**

# Table of Contents

- [Features](#features)
- [Usage](#usage)
- [Setup](#setup)
- [Contributing](#contributing)
  - [Developer Guidelines and Repository Setup](#developer-guidelines-and-repository-setup)
  - [Development Previews](#development-previews)
- [License](#license)
- [Credits](#credits)
  - [Special Thanks](#special-thanks)
  - [Contributors](#contributors)

# Features

Chorizo is designed to revolutionize course management with its cutting-edge features

- **Highly Configurable**: Customize Chorizo to your needs with a wide range of configuration options.
- **Self-Hosting**: Gain full control over your data and course material by hosting Chorizo on your own server.
- **Angular Frontend**: Enjoy a sleek, responsive user interface designed using Angular, optimized for both desktop and
  mobile devices.
- **Firebase Backend**: Benefit from a robust, scalable backend powered by Firebase, ensuring high performance and
  reliability.
- **Efficient Course Management**: Create and manage entry lists, share resources, and streamline course administration
  with ease.
- **Downloadable Resources**: Offer students and course participants easy access to downloadable course materials.
- **Comprehensive Documentation**: Find all the information you need in our extensive documentation, making it easier to
  get started and resolve any issues.

# Usage

Chorizo is a self-hosted course management platform that allows you to manage courses, create entry lists, and share
downloadable resources seamlessly. To get started with Chorizo, follow these steps:

- **@chorizo/cli**: The Chorizo CLI is a command-line interface that helps you set up and manage your Chorizo project(
  s).
- **@chorizo/course**: The Chorizo course package contains the Angular frontend for the course management platform.
- **@chorizo/adminui**: The Chorizo adminui package contains the Angular frontend for the admin dashboard.

- **Firebase**: Chorizo uses Firebase for the backend, including authentication, storage, and database services.
- **TailwindCSS**: Chorizo uses TailwindCSS for styling, providing a highly customizable and responsive user interface.
- **Angular**: Chorizo is built using Angular, a powerful and popular web application framework.
- **Typescript**: Chorizo is written in Typescript, a statically typed superset of JavaScript that enhances code quality
  and maintainability.

> **Disclaimer**: Chorizo is licensed under the MIT License. By using Chorizo, you agree to the terms of the license.

# Setup

To get started with Chorizo, follow these steps:

1. Install the Chorizo CLI globally:

```bash
npm install -g @chorizo/cli
```

2. Create a new Chorizo project:

```bash
chorizo init
```

3. Follow the instructions to set up your project.

# Contributing

Contributions are appreciated and needed to make Chorizo the best course management platform out there. If you want to
contribute, please read
the [Contributing Guidelines](.github/CONTRIBUTING.md), [Code of Conduct](.github/CODE_OF_CONDUCT.md),
and [Developer Certificate of Origin](.github/DCO.md) first.

## Developer Guidelines and Repository Setup

We have several documents for developers to help them get started with the project. You can find them in the `docs`
or `.github` directory. Here are some of the most important ones:

- [Contributing Guidelines](.github/CONTRIBUTING.md)
- [Workflow](docs/WORKFLOW.md)
- [Developer Setup](docs/DEVELOPER_SETUP.md)
- [Best Practices](docs/BEST_PRACTICES.md)
- [Formatting](docs/FORMATTING.md)
- [Dev Actions](docs/DEV_ACTIONS.md)

## Development Previews

We deploy the latest development version of Chorizo to Firebase Hosting. You can find the latest preview at:

- [Course Development Preview](https://dev-preview-course-chorizo.web.app/)
- [AdminUI Development Preview](https://dev-adminui-chorizo.web.app/)

# License

This project is licensed under the [MIT License](LICENSE). By contributing to Chorizo, you agree that your contributions
will be released under the same license. Also, you agree to
the [Contributor Covenant Code of Conduct](.github/CODE_OF_CONDUCT.md)
and [Developer Certificate of Origin](.github/DCO.md).

# Credits

## Special Thanks

Thanks to the following projects and their contributors for making Chorizo possible:

- [DaisyUI](https://daisyui.com/)
- [FireCMS](https://firecms.co/)
- [Angular](https://angular.io/)

## Contributors

Thanks to the following people for their contributions:

[![Contributors](https://contrib.rocks/image?repo=danieljancar/chorizo)](https://github.com/danieljancar/chorizo/graphs/contributors)

Released under [MIT License](LICENSE) by [@danieljancar](https://github.com/danieljancar).

chorizo

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README