appventure-nush/e-notes

E-Notes Platform, courtesy of AppVenture

E-Notes

Electronic Notes management system.

Functions

• Role based permission system
• User & role management system
• Display notes in Markdown, HTML or Jupyter Notebooks
• Management of collections and notes
• Image uploading

Maintaining

• frontend/
  • Vue.js application written in TypeScript
  • Is the frontend of the application, everything is client side
• backend/
  • express.js API backend written in TypeScript
  • Is the backend of the application, everything is server side
• IDE (optional)
  • .idea/: WebStorm by JetBrains

Testing/Development

To run the application, two npm scripts are to be run simultaneously.

• backend/ npm run start:dev with environment ENVIRONMENT=local
  • This will run the backend server on port 8080 unless otherwise specified with PORT environment
  • Will automatically restart when changes are made to the code base
  • This is the access point (the application)
• frontend/ npm run serve
  • Will run the frontend on port 8090
  • This will be used by the backend (the backend acts as a proxy to port 8090)
  • 8090 the port is hardcoded into the backend proxy (proxy only used for development)
  • Will automatically restart when changes are made to the code base
  • This is the frontend, but do not access this port

Building

Simply run npm run build under backend to build both backend and frontend. The frontend build output is also automatically copied over.

e-notes's Issues

Note Reading Progress

save progress of reading notes, done with a vuetify collider

• when a cell is read, it sends a signal to sevrer
• server saves the state in a local database
• client caches info
• displays progress bar
• grey out note if fully read

[API] Notes

Things to do for notes

• Setup firebase storage to store notes
• API Endpoint to upload notes
• Allow notes editing (reupload/renaming)
• Endpoint to access notes
• Custom styling (optional/future)
• Comments on notes (optional)
• Version history (optional)

Things to continue for collections

• Endpoint to list accessible collections
• Caching of collections
• Tests on role system

[API] Permission System

Here are some simple goals to meet in the near future (1-2 weeks)

• Roles
  • Create new roles
  • Remove roles
  • Change permissions
• Login System
  • Add login
  • Add user info in firebase
  • Allow assigning roles to users
• Permission
  • Get list of permissions with user
  • Actually acting like a permission system
  • Per-user-permission system (optional)

[API] Mutable Permissions

For permissions, allow advanced editing of permission bit masks.

• Change storage
• Change checking part
• Migrate data

Client Side Customization

• Settings page
  • Show pages
  • Theme customization
  • Markdown settings
• Hide/Show collections
• Pinned collections

[API] Multiple Teacher Support

• Owner property inside collection
  • Permission System
  • Display
• Teacher tag, user allowed to make new collections

Add Custom Styling for Notes

Allow teachers to set styles such as note font/size/padding etc!

Add Commenting Feature for Notes

Allow student/teacher to comment on specific line / code block.

[Front End] Student Panel

• Add tree view
• Add collections and its notes to tree view
• Add roles to tree view
• Add profile to tree view

Version Control

• API for history changes, currently old notes are stored as [collection]/[note]/[date it was replaced] in the path.
  Backend should be able to list files based off that and return them in a nicely formatted array
• Frontend display
  • List of historical versions
  • Comparing two versions
    • https://www.npmjs.com/package/diff seems useful
  • Downloading old versions

Role Lazy-Adding

Create some storage system to store "role assignment action" for users that dont yet exist.
When new user is created, if there exist such a role to be assigned, it should be.