mirror of
https://github.com/rzmk/learnhouse.git
synced 2025-12-18 11:59:26 +00:00
99 lines
3.5 KiB
Markdown
99 lines
3.5 KiB
Markdown
<p align="center">
|
|
<a href="https://learnhouse.app">
|
|
<img src=".github/images/readme.png" height="300">
|
|
</a>
|
|
</p>
|
|
|
|
LearnHouse is an open source platform that makes it easy for anyone to provide world-class educational content and it offers a variety of content types : Dynamic Pages, Videos, Documents & more..
|
|
|
|
## Progress
|
|
|
|
🚧 LearnHouse is still on early development (alpha), as we reach stability we will release a stable version and add more features.
|
|
|
|
## Roadmap
|
|
|
|
We prioritize issues depending on the most requested features from our users, please help us prioritize issues by commenting on them and sharing your thoughts
|
|
|
|
[🚢 LearnHouse General Roadmap](https://www.learnhouse.app/roadmap)
|
|
|
|
[👨💻 Detailed Roadmap](https://github.com/orgs/learnhouse/projects/4)
|
|
|
|
## Overview
|
|
|
|
|
|
|
|
- 📄✨Dynamic notion-like Blocks-based Courses & editor
|
|
- 🏎️ Easy to use
|
|
- 👥 Multi-Organization
|
|
- 📹 Supports Uploadable Videos and external videos like YouTube
|
|
- 📄 Supports documents like PDF
|
|
- 👨🎓 Users & Groups Management
|
|
- 🙋 Quizzes
|
|
- 🍱 Course Collections
|
|
- 👟 Course Progress
|
|
- 🛜 Course Updates
|
|
- 💬 Discussions
|
|
- ✨ LearnHouse AI : The Teachers and Students copilot
|
|
- 👪 Multiplayer Course edition
|
|
- More to come
|
|
|
|
## Community
|
|
|
|
Please visit our [Discord](https://discord.gg/CMyZjjYZ6x) community 👋
|
|
|
|
## Contributing
|
|
|
|
Thank you for you interest 💖, here is how you can help :
|
|
|
|
- [Getting Started](/CONTRIBUTING.md)
|
|
- [Developers Quick start](https://docs.learnhouse.app/setup-dev-environment)
|
|
- [Submit a bug report](https://github.com/learnhouse/learnhouse/issues/new?assignees=&labels=bug%2Ctriage&projects=&template=bug.yml&title=%5BBug%5D%3A+)
|
|
- [Check good first issues & Help Wanted](https://github.com/learnhouse/learnhouse/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+label%3A%22help+wanted%22)
|
|
- Spread the word and share the project with your friends
|
|
|
|
## Documentation
|
|
|
|
- [Overview](https://docs.learnhouse.app)
|
|
- [Developers](https://docs.learnhouse.app/setup-dev-environment)
|
|
|
|
## Get started
|
|
|
|
### Get a local ready copy of LearnHouse
|
|
|
|
TLDR: Run `docker-compose up -d` and inspect the logs, should be ready to go in less than 2 mins
|
|
|
|
- [Self Hosting](https://docs.learnhouse.app/self-hosting/hosting-guide)
|
|
|
|
### Set-up a Development Environment
|
|
|
|
- [Detailed Guide](https://docs.learnhouse.app/setup-dev-environment)
|
|
|
|
## Tech
|
|
|
|
LearnHouse uses a number of open source projects to work properly:
|
|
|
|
- **Next.js** (14 with the App Directory) - The React Framework
|
|
- **TailwindCSS** - Styling
|
|
- **Radix UI** - Accessible UI Components
|
|
- **Tiptap** - An editor framework and headless wrapper around ProseMirror
|
|
- **FastAPI** - A high performance, async API framework for Python
|
|
- **YJS** - Shared data types for building collaborative software
|
|
- **PostgreSQL** - SQL Database
|
|
- **Redis** - In-Memory Database
|
|
- **LangChain** - LangChain is a framework for developing applications powered by language models
|
|
- **React** - duh
|
|
|
|
## LearnHouse University
|
|
|
|
<a href="https://university.learnhouse.io">
|
|
<img width="208" alt="lh_univ" src="https://github.com/learnhouse/learnhouse/assets/29493708/72a892cd-7c5a-4437-9130-ff1682a10b24">
|
|
</a>
|
|
|
|
Learn about LearnHouse and how to use it, using LearnHouse
|
|
|
|
|
|
## A word
|
|
|
|
Learnhouse is made with 💜, from the UI to the features it is carefully designed to make students and teachers lives easier and make education software more enjoyable.
|
|
|
|
Thank you and have fun using/developing/testing LearnHouse !
|