Add docs for the different projects

[Venefilyn]

Just by glancing at this repo I can't make heads or tails what is being used, if there's anything unused, or what the difference between the repos are

I assume that:

• /Snoowrap is the general front-end website
• /SnooNotesAPI is for the actual API that handles requests from web extension
• /SnooNotesAddon is outdated as /SnooNotesExtension exists
• /SnooNotesDB is for MSSQL migrations
• /SnooNotesPermissions is for /SnooNotesAPI to handle permissions
• /SnooNotesSharedLibrary is for use between /SnooNotes, /API and /Permissions
• /SnooNotesTests is tests for just /SnooNotes and nothing else.

Nothing is really clear, nor is there READMEs in each project that dictates what it is for or how to get started

[CrustyJew]

The dev branch is a little more cleaned up, but still has some legacy/unused stuff hanging out that I haven't cleaned up after rebuilding a bunch of it.

SentinelMonitor isn't used as it was ported in to PermissionsMonitor

• IdentProvider is the IdentityServer v4 implementation used for authentication
• SnooNotesExtension is the addon code. Launch it in dev mode with npm run dev or build it with npm run build:chrome or npm run build:firefox
• Snoonotes-website is the website, can't remember off the top of my head on the build command for it. I think it's gulp though
• SnooNotesTests are just some things I was using to test a couple smaller parts of functionality, not a full testing suite by any means
• SnooNotesSharedLibrary is a library with some common classes and functions mostly related to authentication and authorization

Are you trying to host your own version? Or what are you trying to do? I haven't really built it out to be a portable solution to provide self hosting, but it is theoretically possible, you'd have to build and distribute your own version of the extension as well though.

[Venefilyn]

Gotcha. I was interested to see how it all worked and what part did what.

I would love to self-host it, as well as try to improve it if time permits. Only thing holding me back from trying to self-host it is the database limitation of MSSQL.

With development I don't think I'd find the time, but if I did I wouldn't want to spend all my time trying to set it up locally and figure out what's used and not used - hence the questions