Skip to content

AI-powered Japanese vocabulary learning application

Notifications You must be signed in to change notification settings

anoexpected/Hikari-Flash

Repository files navigation

Hikari Flash 🌟

An AI-powered Japanese vocabulary learning application that makes language acquisition fun and interactive. Hikari Flash combines modern web technologies with artificial intelligence to create an engaging flashcard-based learning experience.

License: MIT

📝 Overview

Hikari Flash helps users expand their Japanese vocabulary through an intuitive flashcard system. With features like dark/light mode theming, progress tracking, and AI-powered content generation, it provides a modern approach to language learning.

✨ Features

Core Functionality

  • Interactive Flashcards: Dynamic flashcard system with smooth flip animations
  • AI-Powered Content: Utilizes GROQ API with Llama 3.1 1B model for intelligent content generation
  • Progress Tracking: Session-based progress monitoring to track your learning journey
  • Bilingual Support: Japanese-English word pairs with proper formatting and translations

User Experience

  • Theme Customization: Toggle between dark and light modes for optimal viewing comfort
  • Intuitive Controls: Simple, accessible interface with clearly labeled action buttons
  • Motivational System: Encouraging messages to keep learners motivated
  • Responsive Design: Seamless experience across desktop and mobile devices

🖼️ Screenshots

Hikari Flash Dark Mode

Dark mode interface with motivational message display

Flashcard Example

Example flashcard showing Japanese vocabulary

Flashcard Example

Example flashcard showing Japanese meaning

🚀 Getting Started

Prerequisites

  • Node.js (v14.0.0 or higher)
  • Python 3.8+
  • GROQ API key
  • Git

Installation

  1. Clone the Repository
git clone https://github.com/yourusername/hikari-flash.git
cd hikari-flash
  1. Set Up Backend
cd src/app
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt
  1. Set Up Frontend
cd ../..
npm install
  1. Configure Environment Create a .env file in the project root:
GROQ_API_KEY=your_api_key_here

Running the Application

  1. Start Backend Server
cd src/app
source venv/bin/activate
python app.py
  1. Launch Frontend Development Server
npm run dev
  1. Access the application at http://localhost:3000

🛠️ Technology Stack

Frontend

  • Next.js - React framework
  • Tailwind CSS - Utility-first CSS framework
  • React Hooks - State management
  • JavaScript ES6+ - Core programming

Backend

  • Python 3.x - Server-side language
  • Flask - Web framework
  • GROQ API - AI integration
  • Llama 3.1 1B - Language model

📈 Project Structure

hikari-flash/
├── src/
│   ├── app/
│   │   ├── api/
│   │   └── components/
│   ├── pages/
│   └── styles/
├── public/
├── tests/
└── docs/

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Thanks to GROQ for providing the AI API
  • All contributors who have helped shape Hikari Flash
  • The open-source community for their invaluable tools and libraries

📫 Contact

For support or queries, please open an issue in the GitHub repository or contact the maintainers.


Made with ❤️ for Japanese language learners worldwide

About

AI-powered Japanese vocabulary learning application

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published