rzmk/learnhouse
1
0
Fork 0
mirror of https://github.com/rzmk/learnhouse.git synced 2025-12-19 04:19:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #87 from learnhouse/feat/prepare-readme

Browse source 
Init Readme + Issue Templates
This commit is contained in:
Badr B 2023-05-23 15:58:45 +02:00 • committed by GitHub
commit 2c8c8db0fd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 244 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

58
.github/ISSUE_TEMPLATE/bug.yml vendored Normal file
View file

@ -0,0 +1,58 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
validations:
required: false
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: What version of our software are you running?
placeholder: ex. 0.1.0
validations:
required: true
- type: dropdown
id: browsers
attributes:
label: What browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Arc Browser
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: bash
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our Code of Conduct.
options:
- label: I agree to follow this project's Code of Conduct
required: true

13
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View file

@ -0,0 +1,13 @@
blank_issues_enabled: false
contact_links:
- name: Security Contact
about: Please report security vulnerabilities to security@learnhouse.app
- name: Question or Problem
about: Ask a question or ask about a problem in GitHub Discussions.
url: https://github.com/learnhouse/learnhouse/discussions/categories/questions
- name: Feature Request
about: To suggest an idea or ask about a feature, please start with a question saying what you would like to achieve. There might be a way to do it already.
url: https://github.com/learnhouse/learnhouse/discussions/categories/questions
- name: Show and tell
about: Show what you built with LearnHouse or to be used with LearnHouse.
url: https://github.com/learnhouse/learnhouse/discussions/categories/show-and-tell

22
.github/ISSUE_TEMPLATE/verified.yml vendored Normal file
View file

@ -0,0 +1,22 @@
name: Verified
description: Someone from the team allowed you to create an issue here
body:
- type: markdown
attributes:
value: |
Thanks for your interest in LearnHouse 💖
If you are not someone from the team or the team didn't ask you directly to create an issue here, please start the conversation in a [Question in GitHub Discussions](https://github.com/learnhouse/learnhouse/discussions/categories/questions) instead.
- type: checkboxes
id: verified
attributes:
label: Verified issue
description: Confirm that you are allowed to create an issue here.
options:
- label: Someone from the team allowed me to create an issue here
required: true
- type: textarea
id: content
attributes:
label: Issue Content
description: Add the content of the issue here.

BIN
.github/images/readme.png vendored Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 112 KiB

72
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,72 @@
# Contributing to LearnHouse
## Backend Codebase
### Tech
- **FastAPI** - A high performance, async API framework for Python
- **Pydantic** - Data validation and settings management using Python type annotations.
- **Ruff** - An extremely fast Python linter, written in Rust.
- **Motor** - the async Python driver for MongoDB and Tornado or asyncio
- **Uvicorn** - an ASGI web server implementation for Python.
### Get started
Use the Docker Image available in `./Dockerfile`
docker-compose up -d
Initiate a dev environment, please check the official guide [here](https://docs.learnhouse.app/technical-docs/dev-env)
## Frontend Codebase
### Tech
- **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
- **YJS** - Shared data types for building collaborative software
- **MongoDB** - NoSQL Database
- **React** - duh
### Get started
Use the Docker Image available in `front/Dockerfile`, or install the frontend package on your computer for greater performance.
#### Start the Backend server first
You need to have the backend running, to initiate a dev environment please check the official guide [here](https://docs.learnhouse.app/technical-docs/dev-env)
#### Environment Files
Please check if you initiated your `.env` files, here is a [guide](https://docs.learnhouse.app/technical-docs/dev-env) on how to do it.
#### Install the frontend package
npm i
#### Run in Dev environment
npm run dev
## Submitting Contributions
This project follows [GitHub's standard forking model](https://guides.github.com/activities/forking/). Please fork the project to submit pull requests.
### Submitting a bug/fix
- Start an issue [here](https://github.com/learnhouse/learnhouse/issues) to report the bug.
- Please include a detailed description of the bug and how it can be reproduced.
- Someone from the team will review the issue and will give you a go ahead.
### Submitting a feature / idea
- Start a Discussion [here](https://github.com/learnhouse/learnhouse/discussions/categories/ideas) to propose your idea and how it should be implemented.
- Someone from the team will review your idea and will give you a go ahead.
- Start an issue & link the discussion to it.
- Clone your fork locally
- Create a new branch and make your commits
- Push your commits to your forked repo
- Make a Pull request
- Code will be added after review

79
README.md Normal file
View file

@ -0,0 +1,79 @@
<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) 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](/CONTRIBUTING.md)
- Submit a bug report
- [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
- Features
- [Courses](https://docs.learnhouse.app/features/courses)
- [Activities](https://docs.learnhouse.app/features/activities)
- [Dynamic Pages](https://docs.learnhouse.app/features/activities/dynamic-pages)
- [Video Activities](https://docs.learnhouse.app/features/activities/video)
- [Document Activities](https://docs.learnhouse.app/features/activities/documents)
- [Collections](https://docs.learnhouse.app/features/collections)
- [Trail](https://docs.learnhouse.app/features/trail)
- Self Hosting
- [Overview](https://docs.learnhouse.app/technical-docs/self-hosting/overview)
- [Organization Hosting Modes](https://docs.learnhouse.app/technical-docs/self-hosting/organization-hosting-modes)
- [Docker & Kubernetes](https://docs.learnhouse.app/technical-docs/self-hosting/docker-and-kube)
- [Using Vercel](https://docs.learnhouse.app/technical-docs/self-hosting/vercel)
- Content Storage
- [Using the Filesystem](https://docs.learnhouse.app/technical-docs/self-hosting/content-storage/filesystem)
- [Using AWS S3 or CloudFlare R2](https://docs.learnhouse.app/technical-docs/self-hosting/content-storage/s3)
- Technical Docs
- [Infrastructure Overview](https://docs.learnhouse.app/technical-docs/infra-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 !