https://github.com/nimjay/treel
Treel is a minimalistic learning management system (LMS).
https://github.com/nimjay/treel
cms college education lms minimalistic school university
Last synced: 5 months ago
JSON representation
Treel is a minimalistic learning management system (LMS).
- Host: GitHub
- URL: https://github.com/nimjay/treel
- Owner: NimJay
- License: apache-2.0
- Created: 2018-01-08T17:28:53.000Z (over 8 years ago)
- Default Branch: develop
- Last Pushed: 2018-05-21T17:01:17.000Z (about 8 years ago)
- Last Synced: 2025-11-29T23:49:28.111Z (7 months ago)
- Topics: cms, college, education, lms, minimalistic, school, university
- Language: JavaScript
- Size: 191 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Treel
===
Treel is a minimalistic learning management system that allows instructors to distribute class content to students.
## Description
A user of Treel is either an **Instructor** or a **Student**. Instructors create **Class** pages which Students can **Follow**. Each Class may have multiple Instructors who can add/edit Class **Content** (e.g., assignment handouts). Class pages can be made **public** (allowing anyone to Follow), or **private** (allowing only a specified list of Students to Follow).
## File Structure
The two lists below detail key folders/files of this project:
### Folders
- **other/** Miscellaneous files.
- **src/** The source code.
- **src/back/** Back-end code.
- **src/front/** Front-end code.
- **src/public/** Files to be served by the server.
- **src/public/css/** All CSS to be served.
- **src/public/img/** All images (excluding favicon.png) to be served.
- **src/public/js/** All JavaScript to be served.
- **src/sass/** All SASS files.
### Files
- **src/back/Server.js** Run this to start the server.
- **src/front/Treel.jsx** This is compiled intro _treel.js_ via `webpack`.
- **src/public/css/treel.css** Main CSS file (result of compiling _treel.scss_).
- **src/public/js/treel.js** Main JavaScript file (result of compiling _Treel.jsx_).
- **src/sass/treel.scss** This is compiled into _treel.css_ via `node-sass`.
## Run On Your Machine
To run Treel on your machine:
1. Install [Node](https://nodejs.org) (with npm) and [MongoDB](https://www.mongodb.com/).
2. `git clone https://github.com/NimJay/treel.git`
3. `cd treel/src/`
4. `npm install` (This may take a while.)
5. Configure `back/Config.js` as needed.
6. `node back/LoadData.js` to load initial MongoDB data.
7. `npm run develop` to compile SASS+ES6+JSX and run server.
8. `touch sass/treel.scss` to trigger a SASS compilation.