Skip to content

This project combines modern web technologies with AI to create a personalized learning experience. πŸš€

License

Notifications You must be signed in to change notification settings

polishdomOfficial/app.polishdom

Repository files navigation

PolishDom - Polish Language Learning Platform πŸŽ“

Welcome to PolishDom, a platform for learning Polish language through interactive lessons and quizzes. This project combines modern web technologies to create an engaging learning experience. πŸš€

✨ Features

  • πŸ“ Multiple question types:
    • Multiple choice questions
    • Fill-in-the-blank exercises
    • True/False questions
  • 🎯 Interactive quiz system with:
    • Progress tracking
    • Score calculation
    • Streak counter
    • Hint system
  • πŸ”Š Audio feedback for correct/incorrect answers
  • πŸ“± Responsive design with smooth animations
  • πŸŒ“ Dark/Light mode support
  • πŸ“Š Real-time progress tracking
  • πŸ”„ Quiz review and reset functionality
  • πŸ“š Theory section with:
    • Markdown content support
    • Text-to-speech functionality
    • Interactive navigation

πŸ› οΈ Tech Stack

  • ⚑ Next.js 15
  • βš›οΈ React 19
  • πŸ“˜ TypeScript
  • 🎨 Tailwind CSS with typography plugin
  • ✨ Framer Motion for animations
  • πŸ€– AI Integration:
    • OpenAI
    • Anthropic
    • Google AI
  • 🎯 Radix UI Components
  • πŸ“ React Markdown with GFM support
  • πŸ”” Sonner for toast notifications
  • βœ… Zod for schema validation

πŸš€ Getting Started

  1. Clone the repository:
git clone https://github.com/mirvald-space/app.polishdom.git
cd app.polishdom
  1. Install dependencies:
npm install
# or
yarn install
# or
pnpm install
  1. Set up environment variables:

    • Copy .env.example to .env
    • Add your API keys:
      GOOGLE_API_KEY=your_google_api_key
      ANTHROPIC_API_KEY=your_anthropic_api_key
      OPENAI_API_KEY=your_openai_api_key
      
  2. Start the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
  1. Open http://localhost:3000 in your browser πŸŽ‰

πŸ“ Project Structure

app.polishdom/
β”œβ”€β”€ app/                    # Next.js app directory
β”‚   β”œβ”€β”€ (preview)/         # Preview routes
β”‚   └── api/               # API routes
β”œβ”€β”€ components/            # React components
β”‚   β”œβ”€β”€ ui/               # UI components
β”‚   β”œβ”€β”€ quiz.tsx          # Main quiz component
β”‚   β”œβ”€β”€ quiz-overview.tsx # Quiz review component
β”‚   β”œβ”€β”€ theory.tsx        # Theory section component
β”‚   β”œβ”€β”€ question-types.tsx # Question type components
β”‚   β”œβ”€β”€ audio-player.tsx  # Audio feedback component
β”‚   └── markdown.tsx      # Markdown renderer
β”œβ”€β”€ lib/                   # Utility functions and configurations
β”‚   β”œβ”€β”€ schemas.ts        # Zod schemas
β”‚   └── utils.ts          # Helper functions
β”œβ”€β”€ public/               # Static assets
└── types/                # TypeScript type definitions

🀝 Contributing

Contributions are welcome! Feel free to submit a Pull Request. Let's make this project even better together! πŸ’ͺ

πŸ“„ License

MIT

🌟 About

PolishDom is designed to make Polish language learning accessible and engaging. The platform provides interactive lessons with theory sections and quizzes to help learners practice and reinforce their knowledge. Whether you're a beginner or looking to improve your Polish skills, PolishDom offers a structured approach to learning. πŸ“š


Made with ❀️ by Vadym

About

This project combines modern web technologies with AI to create a personalized learning experience. πŸš€

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •