Tool that allows users to upload their Kindle highlights, receive daily notifications with selected highlights, and browse through their saved highlights effortlessly. ✨
-
📥 Kindle Highlight Upload: Easily import your Kindle highlights from HTML files.
-
📚 Book and Highlight Viewing: Browse and review your highlights organized by book.
-
📝 Add Personal Notes: Attach your own thoughts or reflections to each highlight.
-
⏰ Scheduled Email Notifications: Receive daily email digests of your highlights at configured times.
✨ Quote
"To read without reflecting is like eating without digesting." — Edmund Burke
-
Clone the repository:
git clone https://github.com/itsfelipe-dev/KindleVault.git cd KindleVault -
Install Composer dependencies:
composer install
-
Copy the
.env.examplefile and configure your environment variables:cp .env.example .env php artisan key:generate
Edit the
.envfile to set up your database connection, email settings, and other environment-specific configurations. -
Run database migrations:
php artisan migrate
-
Serve the application:
php artisan serve
You can then access the application in your browser, usually at
http://localhost:8000, and create a new account.
Each user must configure their SMTP settings via their profile page (user/profile).
The scheduling for the daily highlight emails is configured in the app/Console/Kernel.php file. By default, the application is set to send emails twice daily at 9:00 AM and 7:00 PM server time:
$schedule->job(new \App\Jobs\SendDailyHighlightEmail)->twiceDaily(9, 19);To modify the frequency, update the scheduler using any Laravel scheduling methods. Schedule Frequency Options
This application utilizes Laravel Queues to handle email notifications. To start the queue worker, run the following command:
php artisan queue:work* * * * * php /path/to/your/project/artisan schedule:run >> /dev/null 2>&1The email template is located at resources/views/emails/highlight.blade.php.