Skip to content

fatemeh-shahrabi/Khodnevis

Repository files navigation

Khodnevis – AI-powered Note-taking Assistant

Khodnevis is an intelligent Persian-language web app that converts audio into structured summaries using Whisper for transcription and GPT for content generation.


Project Overview

Taking structured notes from audio content can be time-consuming. Khodnevis simplifies this by allowing users to upload audio files and receive clean, categorized pamphlets.


Technologies Used

Laravel Livewire Tailwind CSS OpenAI SQLite


Features

  • Upload audio files (MP3, WAV, AAC, OGG, FLAC)
  • Generate structured pamphlets with introduction, body, and conclusion
  • Whisper transcription + GPT content generation
  • History panel to manage previous pamphlets
  • Custom prompt input for personalized summaries

Project Status

In develope for better performance.


Screenshots

All screenshots are in the [screenshots](./screenshots folder:

form pamphlet

Getting Started

Follow these steps to run the project locally:

# 1. Clone the repository
git clone https://github.com/fatemeh-shahrabi/khodnevis.git
cd khodnevis

# 2. Install PHP dependencies
composer install

# 3. Install frontend assets
npm install && npm run build

# 4. Copy .env config
cp .env.example .env

# 5. Generate app key
php artisan key:generate

# 6. Create SQLite DB file
touch database/database.sqlite

# 7. Update your .env file:
# DB_CONNECTION=sqlite
# DB_DATABASE=/absolute/path/to/database/database.sqlite

# 8. Run migrations
php artisan migrate

# 9. Link storage
php artisan storage:link

# 10. Start dev server
php artisan serve

Environment Variables

Make sure to add your OpenAI API key in the .env file

OPENAI_API_KEY="your_openai_api_key_here"

Project Structure

app/
├── Livewire/Pamphlet/SinglePagePamphlet.php
├── Service/MetisClient.php
├── Service/TranscriptionService.php
├── Models/Pamphlet.php

resources/views/
├── welcome.blade.php
└── livewire/pamphlet/single-page-pamphlet.blade.php

About

AI-powered Persian note-taking app using Laravel, Livewire, Whisper, and GPT.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published