Notare is an open source note-taking app for educational YouTube videos. It consists of a Google Chrome extension for note-taking and a companion webapp for note and video organisation, both communicating with a common Flask REST API backend with SQLite database.
- Replace the Flask SQLite backend with Firebase.
- Various UX improvements, including rich text.
The follow instruction are for Mac and Linux computers.
If you want to run the frontend, extension and backend together, follow these instructions:
- Clone the repository by running
git clone https://github.com/alexanderj2357/Notare - Ensure you have the following software installed:
- Python 3, can be installed from https://www.python.org/downloads/
- virtualenv, can be installed using
python3 -m pip install virtualenv - Node.js, can be installed from https://nodejs.org/en/download/
- npm, can be installed from https://www.npmjs.com/get-npm/
- yarn, can be installed from https://yarnpkg.com/lang/en/docs/install/
- Ensure you are in
Notare/ - Run
sh run.shto run the frontend, backend and extension - If the extension is installed on Google Chrome, refresh it from chrome://extensions once the extension completes building
If you want to run the frontend, backend and extension separately, follow the instructions above and then open 3 separate shells and run the following in each shell:
- Run
sh run_backend.shto run the backend. - Run
sh run_frontend.shto run the frontend. - Run
sh run_extension.shto run the extension.
To run the frontend, backend and extension manually, check the README.md in their respective directories.
- Complete the steps to build the project above.
- Go to chrome://extensions in Google Chrome.
- With the developer mode checkbox ticked, click Load unpacked and select the
dist/folder from this repo.
Please run the following command: sh run_backend_tests.sh