Giter Club home page Giter Club logo

platform's Introduction

Class Representatives Web Platform

A platform for class representatives to share information to students.

This platform currently has the following functions:

  • A home page with:
    • Links and resources
    • Alerts
    • List of class representatives
  • Announcements page
    • Supports announcements written in Markdown, with tags support.
  • Anonymous tickets
    • Allows students to anonymously post tickets and upvote them
    • Has a voter ID to anonymously track upvotes without storing sensitive information or session.
  • Complaints system
    • Allows students to anonymously send complaints directly to their representatives.
    • Automatically detects the class representatives responsible for a specific course.
  • Moderation log
    • Logs class representatives administrative actions on the website for transparency.
  • Online configurator
    • Allows class representatives to update the website's configuration (such as course and professor listing) online.

2. Requirements

The following packages must be installed on your system.

  • Go (tested with 1.14)
  • Git

3. Copying and contributing

This program is distributed under the AGPL 3.0 only license. This means if you make your own fork of this app, you must release its source to its users under the same license. You also need to disclose changes done to the software.

4. Downloading and running

$ git clone https://github.com/hw-cs-reps/platform
$ cd platform
$ go build

5. Setup & Usage

Running the web server will automatically generate a configuration file (config.toml) if it is not yet created.

$ ./platform run

The program will exit when run for the first time, prompting you to configure the program.

platform's People

Contributors

akilan1999 avatar alakbarz avatar humaidq avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

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.