Code Monkey home page Code Monkey logo

project-nimbus's Introduction

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...

project-nimbus's People

Contributors

dependabot[bot] avatar jak2k avatar

Watchers

 avatar

Forkers

bainaryglobe

project-nimbus's Issues

Enhanced Moderation

  • Persistant Removing of Words
  • User manager
    • Kicking of Users
    • Closed Joining
    • User list

More modules

  • Word Cloud
  • Vote
  • Rank-Vote
  • Post Zone (Like a tiny social Media)
  • Mindmap
  • Quiz
    • Multiple Choise
    • Number Guessing
    • Freeform text

UI update

  • User-Count (header)
  • Connection Identifier with icons (header)
  • Download-Button for material (header)
  • Waiting screen (after joining, before starting mode)
    • Welcome text shown
    • Other people list
    • Info-Text shown
    • QR-Code
  • PIN display (header)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.