Skip to content

Ghafli/flashcard

Repository files navigation

Flashcard App

A modern flashcard application built with Next.js for effective learning through spaced repetition.

Features

  • 📚 Create and manage flashcard decks
  • 🧠 Spaced repetition learning algorithm
  • 📊 Progress tracking and statistics
  • 🌙 Dark/Light mode support
  • 📱 Responsive design
  • 🔄 Offline support

Quick Start

# Clone the repository
git clone https://github.com/Ghafli/flashcard.git
cd flashcard

# Install dependencies
npm install

# Initialize the project
npm run init

# Start development server
npm run dev

Visit http://localhost:3000 to see the app.

Prerequisites

  • Node.js 16.x or higher
  • MongoDB 4.4 or higher
  • Git

Documentation

Development

# Run tests
npm test

# Run linting
npm run lint

# Build for production
npm run build

# Start production server
npm start

Contributing

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

License

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

Acknowledgments

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published