https://github.com/danieljancar/chorizo
A versatile, firebase hosted, open-source platform for interactive course management and learning experiences. Tailored for small-group instruction across various disciplines.
https://github.com/danieljancar/chorizo
angular chorizo chorizo-learning e-learning education-platform firebase learning-management-system remote-learning self-hosted
Last synced: 11 months ago
JSON representation
A versatile, firebase hosted, open-source platform for interactive course management and learning experiences. Tailored for small-group instruction across various disciplines.
- Host: GitHub
- URL: https://github.com/danieljancar/chorizo
- Owner: danieljancar
- License: mit
- Created: 2024-01-25T13:45:14.000Z (about 2 years ago)
- Default Branch: develop
- Last Pushed: 2025-01-15T13:21:22.000Z (about 1 year ago)
- Last Synced: 2025-04-25T18:56:20.760Z (11 months ago)
- Topics: angular, chorizo, chorizo-learning, e-learning, education-platform, firebase, learning-management-system, remote-learning, self-hosted
- Language: TypeScript
- Homepage: https://www.npmjs.com/org/chorizo
- Size: 3.48 MB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Chorizo
A self-hosted course management platform. Manage courses, create entry lists, and share downloadable resources seamlessly. Fully dynamic and tailored for streamlined administration.
[](https://github.com/danieljancar/chorizo)
[](https://www.figma.com/file/oarKaGgevt8SQNcB2w4Lbr/Mockups?type=design&mode=design&t=CBVvajzXHWh5z6Gf-1)
[](https://github.com/danieljancar/chorizo/issues)
[](#license)
[](https://github.com/danieljancar/chorizo/actions/workflows/lint.yml)
[](https://github.com/danieljancar/chorizo/actions/workflows/triager.yml)
[](https://github.com/danieljancar/chorizo/actions/workflows/format.yml)
[](https://github.com/danieljancar/chorizo/actions/workflows/release.yml)
[](https://github.com/danieljancar/chorizo/actions/workflows/dev-deploy.yml)
[](https://angular.dev)
[](https://tailwindcss.com/)
[](https://www.typescriptlang.org/)
[](https://firebase.google.com/)
---
# ⚠️ 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:
[](https://github.com/danieljancar/chorizo/graphs/contributors)
Released under [MIT License](LICENSE) by [@danieljancar](https://github.com/danieljancar).