mirror of
https://github.com/learnhouse/docs.git
synced 2026-02-18 00:07:39 +01:00
Several Improvements - Vercel, Trails (#3)
* Update index.mdx * Update s3.mdx * Update organization-hosting-modes.mdx * Update vercel.mdx * Update trail.mdx * Update trail.mdx * Update vercel.mdx * Rename vercel.mdx to vercel.txt * Update vercel.txt * Create vercel.mdx * Update _meta.json * Update organization-hosting-modes.mdx * Update pages/features/trail.mdx Co-authored-by: Badr B. <bdswve@gmail.com> * Update pages/features/trail.mdx Co-authored-by: Badr B. <bdswve@gmail.com> * Update vercel.mdx * Update index.mdx --------- Co-authored-by: Badr B. <bdswve@gmail.com>
This commit is contained in:
Leo Wilkin
@@ -2,4 +2,10 @@ import { Callout } from 'nextra-theme-docs'
|
||||
import { Card, Cards } from 'nextra-theme-docs'
|
||||
import Image from 'next/image'
|
||||
|
||||
# Trail
|
||||
# Trail
|
||||
|
||||
Trails are a key feature on Learnhouse that enables teachers & students to track their progress through Courses.
|
||||
|
||||
By using Trails, teachers can effectively use quiz results and text-based course progression to tailor feedback in-person & remotely. It also lets students keep a track of their own progression through the course, and encourage increased self-determination & confidence.
|
||||
|
||||
|
||||
|
||||
@@ -2,21 +2,21 @@
|
||||
|
||||
## What is LearnHouse?
|
||||
|
||||
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..
|
||||
LearnHouse is an open source LMS (learning management system) platform that makes it easy for anyone to provide world class educational content. One of the main features is that it offers a variety of content types: Dynamic Pages, Videos, Documents & more..
|
||||
|
||||
<br/>
|
||||
<img quality={100} src="/img/pages/features.png" alt="Hello" />
|
||||
|
||||
## Features
|
||||
|
||||
- 📄✨Dynamic notion-like pages
|
||||
- 👨🎓 Easy to use
|
||||
- 👥 Multi-Organization
|
||||
- 📄✨ Dynamic Notion-like WYSIWYG pages
|
||||
- 👨🎓 Easy & simple to use
|
||||
- 👥 Multi-Organizational
|
||||
- 📹 Supports Uploadable Videos and external videos like YouTube
|
||||
- 📄 Supports documents like PDF
|
||||
- 🍱 Course Collections
|
||||
- 🙋 Quizzes
|
||||
- 👟 Course progress
|
||||
- 🙋 Interactive Quizzes
|
||||
- 👟 Overall course progress
|
||||
- ⚡ (Incoming) Live Collaboration
|
||||
- More to come
|
||||
|
||||
|
||||
@@ -3,6 +3,6 @@
|
||||
"configuration": "Configuration",
|
||||
"organization-hosting-modes": "Organization Hosting Modes",
|
||||
"docker-and-kube": "Docker and Kubernetes",
|
||||
"vercel": "Using Vercel",
|
||||
"vercel": "Vercel",
|
||||
"content-storage": "Content Storage"
|
||||
}
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
import { Callout } from 'nextra-theme-docs'
|
||||
|
||||
# S3
|
||||
|
||||
<Callout type="info" >
|
||||
We're still working on S3-compatible storage support.
|
||||
</Callout>
|
||||
</Callout>
|
||||
|
||||
@@ -14,7 +14,7 @@ Your Organizations will share the same database and have their content, files, u
|
||||
|
||||
## Single Organization setup
|
||||
|
||||
<Callout type="info">Single Organization setup is the default when installing learnhouse for the first time.</Callout>
|
||||
<Callout type="info">Single Organization setup is the default when installing Learnhouse for the first time.</Callout>
|
||||
|
||||
When using a Single Organization Setup you should refer your Organization's `slug` in the **frontend config file**
|
||||
|
||||
@@ -27,6 +27,8 @@ NEXT_PUBLIC_LEARNHOUSE_DEFAULT_ORG=defaultorg
|
||||
|
||||
## Multi Organization setup
|
||||
|
||||
<Callout type="info">At the moment, only Single Organizations are supported by Self-Hosting.</Callout>
|
||||
|
||||
### Frontend Config
|
||||
|
||||
```bash filename="apps/web/.env" {1-2}
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
import { Callout } from 'nextra-theme-docs'
|
||||
import { Callout } from "nextra-theme-docs";
|
||||
|
||||
# Vercel as Frontend
|
||||
|
||||
<Callout type="info" >
|
||||
We're still working on a Vercel guide
|
||||
</Callout>
|
||||
We're still working on a Vercel guide.
|
||||
</Callout>
|
||||
|
||||
33
pages/self-hosting/vercel.txt
Normal file
33
pages/self-hosting/vercel.txt
Normal file
@@ -0,0 +1,33 @@
|
||||
import { Callout } from 'nextra-theme-docs'
|
||||
import { Steps } from 'nextra-theme-docs'
|
||||
|
||||
# Using Vercel as Frontend
|
||||
|
||||
<Callout type="warning" >
|
||||
This is a draft - it should not be published without core team approval.
|
||||
</Callout>
|
||||
<br>
|
||||
|
||||
<Callout type="info" >
|
||||
It's important to note that you can't use Vercel for frontend & backend. Vercel is only hosting the frontend.
|
||||
</Callout>
|
||||
|
||||
<Steps>
|
||||
|
||||
### Deploy to Vercel
|
||||
|
||||
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flearnhouse%2Flearnhouse)
|
||||
Create or log into your Vercel account and clone the repository automatically by clicking on this button.
|
||||
|
||||
### Add Environmental Variables
|
||||
|
||||
In Vercel project settings go to `Settings > Environmental Variables` and paste this .env file into any textbox.
|
||||
|
||||
```env filename="settings/environmental variables" {1-2}
|
||||
NEXT_PUBLIC_LEARNHOUSE_MULTI_ORG=false
|
||||
NEXT_PUBLIC_LEARNHOUSE_DEFAULT_ORG=defaultorg
|
||||
```
|
||||
|
||||
<Callout type="warning">
|
||||
You must have a backend to work with the frontend. Vercel will not and can not run the backend of this project.
|
||||
</Callout>
|
||||
Reference in New Issue
Block a user