10x-cards

Description

10x-cards is a flashcard generation and management application designed to streamline the creation of high-quality educational flashcards. The project leverages AI models to automatically generate flashcard suggestions from user-provided text while also offering functionalities for manual flashcard creation, editing, and deletion. This facilitates an efficient learning process based on spaced repetition.

Tech Stack

• Frontend: Astro 5, React 19, TypeScript 5, Tailwind 4, Shadcn/ui
• Backend: Supabase (PostgreSQL, Authentication)
• AI Integration: Openrouter.ai for LLM interactions
• Testing:
  • Unit & Component Integration: Vitest, React Testing Library
  • End-to-End, API & Security: Playwright
• CI/CD and Hosting: GitHub Actions and DigitalOcean

Getting Started Locally

1. Clone the repository:

   git clone <repository-url>

2. Navigate to the project directory:

   cd 10x_cards

3. Install dependencies:

   npm install

4. Ensure you are using the correct Node.js version: If you have nvm installed, run:

   nvm use

5. Run the development server:

   npm run dev

6. Build and preview:
   • To build the project:

     npm run build

   • To preview the production build:

     npm run preview

Available Scripts

• dev: astro dev - Starts the development server.
• build: astro build - Builds the project for production.
• preview: astro preview - Previews the production build.
• astro: astro - CLI command for Astro.
• lint: eslint . - Runs the linter.
• lint:fix: eslint . --fix - Runs the linter and fixes issues.
• format: prettier --write . - Formats the codebase.
• test:unit: vitest - Runs unit and component tests.
• test:e2e: playwright test - Runs end-to-end tests.
• test: npm run test:unit && npm run test:e2e - Runs all tests.

Project Scope

The project aims to provide:

• Automatic Flashcard Generation: Generate flashcard suggestions using AI models by processing user-provided text.
• Manual Flashcard Management: Create, edit, and delete flashcards manually.
• User Authentication: Secure user registration, login, and account management.
• Spaced Repetition: Integration of a spaced repetition algorithm for effective learning sessions.
• Analytics: Collection of data on generated and accepted flashcards for performance tracking.

Project Status

The project is currently in its MVP stage with core features under active development.

License

This project is licensed under the MIT License.

Table of Contents

• 10x-cards
  • Description
  • Tech Stack
  • Getting Started Locally
  • Available Scripts
  • Project Scope
  • Project Status
  • License