https://github.com/leongmichael/learn-it
AI video generator for math and physics
https://github.com/leongmichael/learn-it
deepgram-api electronjs gemini-api manim
Last synced: 2 months ago
JSON representation
AI video generator for math and physics
- Host: GitHub
- URL: https://github.com/leongmichael/learn-it
- Owner: leongmichael
- Created: 2024-10-19T17:47:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-05T00:14:37.000Z (over 1 year ago)
- Last Synced: 2025-04-12T14:46:58.080Z (about 1 year ago)
- Topics: deepgram-api, electronjs, gemini-api, manim
- Language: Python
- Homepage:
- Size: 95.5 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LearnIt
Learn through generative AI video content. \
## Setup / Installation
- [Install](https://nodejs.org/en/download) Node.js 18 or higher
- [Install](https://www.python.org/downloads/release/python-3110/) 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](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) 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.