Skip to content

Repository files navigation

Better Anki

Better Anki is an enhanced version of Anki, a flashcard-based learning application. This project introduces additional features and improvements to make studying more efficient and engaging.

alt text

Features

Modern UI Components

  • Responsive Drawer Navigation: Mobile-friendly navigation system with smooth transitions
  • Resizable Panels: Customizable layout with draggable panels for desktop view
  • Clean, Minimalist Design: Enhanced visual design for a distraction-free learning experience

Study Tools

  • Custom Heatmap Component: Visualize your study patterns over time
  • Progress Tracking: Detailed insights into your learning journey
  • Advanced Statistics: Comprehensive analytics for better study planning

Card Management

  • Intuitive Deck Organization: Easy-to-use interface for managing flashcard decks
  • Smart Filtering: Advanced search and filter capabilities
  • Customizable Cards: Flexible card templates and formatting options

Dashboard

  • Personal Statistics: Track your daily, weekly, and monthly progress
  • Study Patterns: Analyze your learning habits and optimize your schedule
  • Performance Metrics: Detailed insights into retention rates and study efficiency

Technology Stack

  • Frontend: Next.js, React, TypeScript
  • UI Components: shadcn/ui, Tailwind CSS
  • State Management: React Context
  • Responsive Design: Mobile-first approach

Installation

  1. Clone this repository:
git clone https://github.com/Hritvik-Mohan/better-anki
  1. Navigate to the project directory:
cd better-anki
  1. Install dependencies:
npm install
  1. Run the development server:
npm run dev
  1. Build for production:
npm run build

Development Setup

Prerequisites

  • Node.js (v18 or higher)
  • npm or yarn
  • Git

Contributing

Contributions are welcome! Here's how you can help:

  1. Fork the repository
  2. Create a new branch:
git checkout -b feature/amazing-feature
  1. Make your changes
  2. Commit with descriptive messages:
git commit -m "Add amazing feature"
  1. Push to your branch:
git push origin feature/amazing-feature
  1. Open a Pull Request

Contribution Guidelines

  • Follow the existing code style and conventions
  • Write clear commit messages
  • Update documentation as needed
  • Add tests for new features
  • Ensure all tests pass before submitting PR

License

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

Acknowledgments

  • Inspired by the original Anki flashcard system
  • Built with shadcn/ui components
  • Thanks to all contributors who have helped shape Better Anki

Support

For support, please:

  • Open an issue on GitHub
  • Join our community discussions
  • Check out the documentation

Made with ❤️ by the Better Anki Team

About

Better Anki is a modern take on the classic flashcard app, designed to enhance learning with an improved interface, customizable templates, and advanced features like smarter scheduling and better organization.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Used by

Contributors

Languages