Skip to content

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

License

Notifications You must be signed in to change notification settings

danieljancar/chorizo

Repository files navigation

Chorizo Logo

Chorizo

A self-hosted course management platform. Manage courses, create entry lists, and share downloadable resources seamlessly. Fully dynamic and tailored for streamlined administration.

NPM Version NPM @chorizo/course Version NPM Version

Chorizo Mockups - Figma issues - chorizo License

Linter Triage Labeler Formatting

Monorepo Release Deploy latest develop changes

Angular TailwindCSS Typescript Firebase


⚠️ 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

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:
npm install -g @chorizo/cli
  1. Create a new Chorizo project:
chorizo init
  1. 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, Code of Conduct, and Developer Certificate of Origin 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:

Development Previews

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

License

This project is licensed under the MIT 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 and Developer Certificate of Origin.

Credits

Special Thanks

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

Contributors

Thanks to the following people for their contributions:

Contributors

Released under MIT License by @danieljancar.

About

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

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks