mirror of
https://github.com/rzmk/learnhouse.git
synced 2025-12-19 04:19:25 +00:00
feat: init readme
This commit is contained in:
parent
c9c261f12f
commit
fa9bc00480
2 changed files with 80 additions and 0 deletions
BIN
.github/images/readme.png
vendored
Normal file
BIN
.github/images/readme.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 112 KiB |
80
README.md
Normal file
80
README.md
Normal file
|
|
@ -0,0 +1,80 @@
|
||||||
|
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://learnhouse.app">
|
||||||
|
<img src=".github/images/readme.png" height="400">
|
||||||
|
</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) and should not be used (yet) on production, as we reach stability we will release a stable version and add more features.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- 📄✨Dynamic notion-like pages
|
||||||
|
- 👨🎓 Easy to use
|
||||||
|
- 👥 Multi-Organization
|
||||||
|
- 📹 Supports Uploadable Videos and external videos like YouTube
|
||||||
|
- 📄 Supports documents like PDF
|
||||||
|
- 🍱 Course Collections
|
||||||
|
- 🙋 Quizzes
|
||||||
|
- 👟 Course progress
|
||||||
|
- ⚡ (Incoming) Live Collaboration
|
||||||
|
- 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
|
||||||
|
- Submit a bug report
|
||||||
|
- Check good first issues
|
||||||
|
- Spread the word and share the project with your friends
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
- Features
|
||||||
|
- Courses
|
||||||
|
- Activities
|
||||||
|
- Dynamic Activities
|
||||||
|
- Video Activities
|
||||||
|
- Documents Activities
|
||||||
|
- Collections
|
||||||
|
- Trail
|
||||||
|
- Self Hosting
|
||||||
|
- Overview
|
||||||
|
- Organization Hosting Modes
|
||||||
|
- Docker / Kubernetes
|
||||||
|
- Using Vercel
|
||||||
|
- Content Storage
|
||||||
|
- Using the FileSystem
|
||||||
|
- Using AWS S3 or Cloudflare R2
|
||||||
|
- Technical Docs
|
||||||
|
- Infrastructure Overview
|
||||||
|
- Database overview
|
||||||
|
- API Overview
|
||||||
|
|
||||||
|
## Tech
|
||||||
|
|
||||||
|
LearnHouse uses a number of open source projects to work properly:
|
||||||
|
|
||||||
|
- **Next.js** (13 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
|
||||||
|
- **MongoDB** - NoSQL Database
|
||||||
|
- **React** - duh
|
||||||
|
|
||||||
|
## 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 !
|
||||||
Loading…
Add table
Add a link
Reference in a new issue