README.md

LearnIt

Learn through generative AI video content.

Setup / Installation

• Install Node.js 18 or higher
• Install Python 3.11 or higher

In the server directory, you need the following yaml configuration file keys.yaml to save the Google Gemini and Deepgram API keys:

gemini: "KEY"
deepgram: "KEY"

Available Scripts

NOTE: Scripts are directory dependent. Certain scripts will not work in other directories.

npm run electron-dev

Runs the application frontend client in the development mode. Make sure to run in the client directory.

npm install

Installs all packages listed in the package.json file in the directory you are in. Make sure to run in the client directory.

npm run format

Formats all code using Prettier. Make sure to run in the client directory to format all JavaScript files.
In VS Code, you can install the plugin Prettier - Code formatter to format code automatically when saving a file.

source env/bin/activate

Starts Python virtual environment. Make sure to run in the server directory.

deactivate

Deactivates Python virtual environment. Make sure to run in the server directory.

pip install -r requirements.txt

Installs all required dependencies to run the Python scripts. Make sure to run in the server directory.