WebNotes is a group project that has been started for our CS 386 class and will continue development till the end of Fall 2024. The existing codebase, with limited functionality, remains available under an MIT license. Please proceed at your own risk.
Web Notes is a simple Chrome extension note-taking software that will allow users to take notes, share them with students, and save them efficiently.
Web Notes is currently available on the Chrome Web store and can be found at our website WebNotes.space. Please contact the developers for any information.
WebNotes uses a Chrome extension for client-side operations. As of now this is an unpacked extension and must be loaded in developer mode on Google Chrome. Future releases will provide the packed version available on the Chrome Store. Our local development server runs on Python using Flask and Flask-Cors, both of which are required to be installed in order for the server to function.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Git
Flask
Flask-Cors
MySql-Connector
Credentials
- Fork the repository, then clone to your local machine.
- Make sure you have the developer mode turned on in Google extensions.
- Choose the "Load Unpacked" option.
- Select the "ClientSide" Folder from our downloaded repository.
- (Optional) Start the local Flask server and set "remoteServer" variable in content.js to its corresponding address.
- Refresh Google Chrome and WebNotes should be ready to use on the extension shortcut on the Google Chrome homepage.
For WebNotes, the deployment utilizes a Flask server hosted on an AWS EC2 instance, where Nginx and Gunicorn establish a reverse proxy to direct requests to the internal Flask application. This setup enhances scalability and performance, ensuring seamless access. The WebNotes Chrome extension is available at webnotes.space and on the Google Chrome Store, providing users with an easy and accessible note-taking tool.
- Landon - Initial work - PequenoCoder
- Lucas - Initial work - lucaslarson25
- Avnish - Initial work - avnishsinha
- Jarom - Initial work - JCraghead
- Ronan - Initial work - uploading3211
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Copyright (c) 2024
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.