danieljancar / chorizo

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

Chorizo

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

---

Table of Contents

• Features
• Usage
• Setup
• Contributing
  • Developer Guidelines and Repository Setup
  • Development Previews
• License
• Credits
  • Special Thanks
  • 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

Detailed instructions on how to use Chorizo for managing your courses will be provided here...

Setup

Detailed instructions on how to set up Chorizo on your own server will be provided here...

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:

• Contributing Guidelines
• Workflow
• Developer Setup
• Best Practices
• Formatting
• Dev Actions

Development Previews

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

• Course Development Preview
• AdminUI Development Preview

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:

• DaisyUI
• FireCMS
• Angular

Contributors

Thanks to the following people for their contributions:

Released under MIT License by @danieljancar.