https://github.com/misprit7/noteation
A sheet music viewer controlled by eye tracking and computer vision
https://github.com/misprit7/noteation
Last synced: 3 months ago
JSON representation
A sheet music viewer controlled by eye tracking and computer vision
- Host: GitHub
- URL: https://github.com/misprit7/noteation
- Owner: misprit7
- Created: 2022-09-17T05:26:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-20T16:11:13.000Z (over 2 years ago)
- Last Synced: 2025-01-14T06:52:45.121Z (5 months ago)
- Language: TypeScript
- Size: 13.5 MB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Noteation
Noteation allows musicians to effortlessly turn pages with facial gestures and annotate virtual sheet music.
Built for Hack the North 2022 and finished as finalists!
# Technologies:
- [AdHawk's MindLink](https://sites.google.com/adhawkmicrosystems.com/hack-the-north-help-center/hardware)
- [TypeScript](https://www.typescriptlang.org/) ([React](https://reactjs.org/))
- [Python](https://www.python.org/) ([Flask](https://flask.palletsprojects.com/en/2.2.x/))
- [CockroachDB](https://www.cockroachlabs.com/)
# Setup
Both the frontend and backend are implemented in this repository in the ``frontend`` and ``backend`` directories respectively, and can be set up independently as outlined below
## Frontend
To install the dependencies, run:
```sh
$ cd frontend
$ yarn install
```
To run the application, run:
```sh
$ yarn start
```
Then head to http://localhost:3000 on a browser to see the frontend!
## Backend
To create a virtual environment and install dependencies, run:
```sh
$ python3 -m venv venv
$ source venv/bin/activate # Unix-like systems
$ source venv/Scripts/activate # Windows
$ pip install -r requirements.txt
```
Once you have tehse dependencies set up, you can run the backend. To run the flask application that interfaces with our CockroachDB database:
```sh
$ python -m flask run
```
The part of our project that actually interfaces with the AdHawk SDK is in `backend/src/main.py`. To run, you must first install the AdHawk vision SDK, which is outside the scope of this readme but see [here](https://www.adhawkmicrosystems.com/api_doc) for documentation. Once that is running, simply call
```sh
$ python ./main.py
```
And events will start being streamed to the CockroachDB database.
# Contributors
Built by [Xander Naumenko](https://www.linkedin.com/in/xander-naumenko/), [Renu Rajamagesh](https://www.linkedin.com/in/renu-rajamagesh/), and [Prayus Shrestha](https://www.linkedin.com/in/prayus-shrestha/).
# Credits
Credits to Website Vectors by Vecteezy for the logos, [AdHawk](https://www.adhawkmicrosystems.com) for the awesome glasses, and the entire Hack the North team for putting together an amazing event.