Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 2.32 KB

README.md

File metadata and controls

53 lines (41 loc) · 2.32 KB
Raw

E-Notes

GitHub issues GitHub Workflow Status GitHub stars Typescript Activity Activity Repo Size website

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.