Skip to content

Real-Time Collaboration Tool for Classrooms

License

Notifications You must be signed in to change notification settings

Jak2k/Project-Nimbus

Repository files navigation

Project-Nimbus

BETA STATUS! DON'T RELY ON IT IN PRODUCTION!

Please give me feedback in the issues tab.

Real-Time Collaboration Tool for Classrooms

Features

  • Real-Time Collaboration
  • Moderation
    • Removing unwanted content
    • Removing permanently
    • Kicking Users & Disallow new ones
  • Self-Hosted locally
  • Modules
    • Wordcloud
    • Vote
    • Quiz
    • Mindmap

Getting Started

Only run this in local networks! Never run this open to the internet.

Termux on android

Tutorial will be enhanced later...

Install

  1. Install Termux
  2. In termux, run
    curl -s "https://raw.githubusercontent.com/Jak2k/Project-Nimbus/main/scripts/install_termux.sh" | sh -s
    

-- OR --

  1. Install Termux
  2. In termux, run pkg update && pkg upgrade (When you get asked for something, type y and press enter)
  3. Run pkg i nodejs git (When you get asked for something, type y and press enter)
  4. Clone the repo
  5. run npm i -g pnpm (When you get asked for something, type y and press enter)
  6. run cd Project-Nimbus
  7. run pnpm i
  8. run pnpm build

Run

  • Run pnpm start

Update

  1. In termux, run cd Project-Nimbus if you are not already in the folder
  2. Run sh ./scripts/update.sh

Linux / Windows

Tutorial will be added later...