Notes

The Notes Project

Created August 14, 2016

Please note the UI is not designed yet. It consists of several components that are being developed and tested.

The goal of the project is to have a way for family and friends that use my media server to report any issues with the content. Request new content, Recommend content to other users, etc...

This project consists of a REST server and client developed in JavaScript with:

• Client-side:

  • AngularJS
  • UI-Bootstrap

• Server-side:

  • node.js
  • restify
  • sequelize
  • winston

• A list of available route paths can be found using the uri: api/routes

  {
      "GET": [
  	"/www\\/?.*/",
  	"api/data/categories",
  	"api/data/priorities",
  	"api/data/statuses",
  	"api/notes",
  	"api/note/:uuid",
  	"api/routes",
  	"api/users",
  	"api/user/:uuid"
      ],
      "POST": [
          "api/note",
          "api/user"
      ],
      "PUT": [
          "api/note",
          "api/user"
      ],
      "DELETE": [
          "api/note/:id",
          "api/user/:id"
      ]
  }`
  

• The server can be found under the /server directory.

  • To run the server use: node plexNotesServer.js while in the server folder.

• The client can be found under the /www directory.

  • To run the client load the index.html page with a web browser while in the www folder.

  Note: If you get a cross domain error when loading the client, you will need to serve the page with a web server, such as the one built into IntelliJ. The reason for this is when the page is loaded though a file:// url some browsers will throw a cross domain exception when the page uses http:// for the REST calls.

Development notes

You must run the web app on the same port as the server is running. Note that in IntelliJ, when a run configuration is created, by default the port is for the intelliJ web server. Right now PlexNotes is meant to be ran on the same server as the data server! This may change in the future to have a configurable url.

---

Although Notes is designed specifically for Media Server(s) the Notes project is not affiliated with Inc.

All trademarks and copyrights are the property of their respective owners.

For more information on go to the offical Plex web site.