Skip to content

Latest commit

 

History

History
52 lines (41 loc) · 1.84 KB

readme.md

File metadata and controls

52 lines (41 loc) · 1.84 KB

Portal++ - A Better Client for BlackBaud's Learning Management System

Netlify Status

Prototype

portalplus.tech

Features/Goals

  • Faster load speed
  • Kanban-style assignment center
  • Dark mode
  • Better mobile UI
  • Multiple themes, which use CSS variables
  • No jQuery
  • Remembers last visited page
  • username autofill
  • no two-step login page
  • API Docs (low priority)
  • Open-Source (GPLv3)

development

prerequisites

netlify-cli must be installed

live-server must be installed

yarn must be installed

dev environment

  • go to the project directory (where you've cloned this repo)
  • run yarn install
  • run netlify dev
    • this will start a live dev server on port 8888 (by default)
    • port 5500 must be available or it WILL NOT WORK
    • if you really need port 5500 for something else, replace every instance of 5500 in netlify.toml with your own port
    • the frontend will be hosted at /frontend/, but when this is deployed, it'll be in /

Recommended:

  • set user.debug_mode to true
  • give user.default_description a value (can be fetched from test_data/test_description.txt)
  • install an editor plugin similar to this one for viewing the todos

contributing

  • add stuff
  • fix bugs
  • etc
  • make a pull request
  • if it adds jQuery you die
  • indent with tabs
  • otherwise it will probably be merged