Skip to content

About

PDF, notlar ve yapay zekâ için kişisel çalışma alanı

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

11 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BetterNotebook

BetterNotebook

Read PDFs, take notes, and ask AI in one workspace.

Status: Preview PHP 8.1 or later MySQL or MariaDB Deployment: Self-hosted

English · Türkçe

Website · Screenshots · Quick start · Server installation

BetterNotebook is a self-hosted study workspace. Select a circuit, formula, or diagram in a PDF, follow a step-by-step explanation alongside the source, and add useful answers to your own notes.

Features

Feature What you can do
Three-panel workspace Read a PDF, edit a note, and chat with AI side by side. Resize and reorder the panels.
PDF tools Split a document by page range, ask about a selected area, and review page annotations.
Rich notes Start with a blank note, highlight text, write equations, and insert AI answers.
Library and study sessions Reuse files across notes and track focus sessions by course.
Trash Restore notes, files, and courses within 30 days, or empty the trash manually.

Screenshots

Annotated circuit PDF with the step-by-step explanation panel

BetterNotebook workspace with PDF, note editor, and AI tools

PDF explanations File library
Step-by-step explanation on a sample circuit File library and linked notes

Settings with language and Gemini connection options

Screenshots use sample study material.

Quick start

Requirements: PHP 8.1 or later, MySQL or MariaDB, and the pdo_mysql, mbstring, curl, openssl, and fileinfo PHP extensions.

  1. Clone the repository. Create an empty database and a database user with permissions on it. Copy app/config/database.example.php to app/config/database.custom.php and fill in your database settings.

  2. From the repository root, run the command twice. Each run generates a distinct 64-character value.

    php app/scripts/database.php secret
    php app/scripts/database.php secret

    Replace the placeholders in app/config/database.custom.php with the outputs in order:

    define('BETTERNOTEBOOK_ENCRYPTION_KEY', 'FIRST_OUTPUT');
    define('BETTERNOTEBOOK_SETUP_TOKEN', 'SECOND_OUTPUT');

    The second output is the setup code you enter in the browser. The first output stays on the server and encrypts stored Gemini keys. Keep both values out of Git.

  3. Start the local server from the repository root.

    php -S 127.0.0.1:8080 -t app dev/router.php
  4. Open the setup screen. Enter the setup token and create your first account. After setup, remove only BETTERNOTEBOOK_SETUP_TOKEN from the configuration and keep a secure backup of BETTERNOTEBOOK_ENCRYPTION_KEY.

  5. Sign in. To use AI features, add your Gemini API key under Settings.

Server installation

Use app/ as the document root for a dedicated domain or subdomain. The app includes Apache rewrite rules and an Nginx/PHP-FPM example. Create the database first, make uploads/notes/ writable by PHP, and complete initial setup over HTTPS.

Run php scripts/database.php upgrade from the application directory when upgrading an existing installation. Schedule php scripts/database.php purge-trash hourly to remove expired items. The detailed server guide covers Apache, Nginx, cPanel, and migration. Installation guide in Turkish

Repository layout

Path Purpose
app/ PHP application, runtime assets, and database schema
dev/ Local PHP development router
editor-source/ Rich-text editor source and dependency lockfile
site/ Static product website
docs/ Installation guides, branding, and screenshots

License

The project license will be selected before the first public release. Bundled third-party components include their license notices.

About

PDF, notlar ve yapay zekâ için kişisel çalışma alanı

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages