J-Learn - Laravel Japanese Study Workspace

J-Learn is a self-hosted Japanese study workspace built with Laravel 13, React, and SQLite. It helps learners organize vocabulary, kanji, grammar, and study materials on their own server.

The workspace includes searchable study records, flashcards, CSV import and export, Jisho search, a Kanji canvas, and AI-assisted quizzes. AI features require a buyer-supplied OpenAI or Google Gemini API key and may incur provider charges.

The package includes editable Laravel and React source, database migrations, and English installation documentation. Deployment requires PHP, Composer, Node.js, and a properly configured web server.

Demo access: user@example.com / usertest. Destructive actions are disabled in the demo.

Features

Vocabulary

Manage kanji, kana, romaji, meanings, and word types with search and pagination.

Kanji

Store readings, meanings, example sentences, stroke counts, and flashcards. Data import and export are managed from the Profile page.

Grammar and particles

Organize Bunpou grammar patterns and Joshi particles with examples and searchable records.

Practice tools

Use Jisho search, Kana conversion, an interactive Kanji canvas, and AI-generated quizzes.

Requirements

Server Requirements:

• PHP 8.3 or higher • Database: PDO SQLite (default) or PDO MySQL • Required PHP Extensions: Ctype, cURL, Fileinfo, JSON, Mbstring, OpenSSL, XML, Tokenizer • Composer 2.x • Node.js & NPM (for asset compilation) • Web Server: Apache or Nginx (with URL rewriting enabled and document root set to /public)

Third-Party Services & API Requirements:

• Brevo SMTP Account (for email verification) • OpenAI or Google Gemini API Key (for AI Quiz features)

Instructions

1. Install Dependencies

Run the following commands in your terminal to install backend and frontend packages:

composer install
npm install

2. Create Environment File & Generate Key

Copy the .env file and generate your application key:

On Windows:

copy .env.example .env
php artisan key:generate

On macOS / Linux:

cp .env.example .env
php artisan key:generate

3. Prepare SQLite Database

Create the database file and run migrations:

php -r "file_exists('database/database.sqlite') || touch('database/database.sqlite');"
php artisan migrate

4. Seed Demo Data (Optional)

To populate sample vocabulary, Kanji, grammar, and the default demo account:

php artisan db:seed

Default Demo Credentials: • Email: user@example.com • Password: usertest

5. Build Frontend Assets

Compile the assets for production:

npm run build

6. Run the Application

Start the Laravel local development server:

php artisan serve

Open http://localhost:8000 in your browser to start using the app.

7. Development Mode (Optional)

For active development with hot-reloading, run Vite in a separate terminal:

npm run dev