10x Cards - Flashcard Generation App

A web application for generating and managing flashcards using AI.

Environment Variables

To run this application, you need to set up the following environment variables:

1. Create a .env file in the root directory of the project.
2. Add the following variables:

SUPABASE_URL=your_supabase_url
SUPABASE_KEY=your_supabase_anon_key
SUPABASE_SERVICE_KEY=your_supabase_service_key (optional)
OPENAI_API_KEY=your_openai_api_key

Getting an OpenAI API Key

To use the flashcard generation feature, you need an OpenAI API key:

1. Sign up for an OpenAI account at https://platform.openai.com
2. Navigate to your API keys section
3. Generate a new API key
4. Add the API key to your .env file as OPENAI_API_KEY

Development

# Install dependencies
npm install

# Start the development server
npm run dev

Testing

The project uses a comprehensive testing strategy with multiple layers:

Unit Testing

# Run unit tests
npm run test:unit

Uses Vitest with React Testing Library for:

• Component testing
• Hook testing
• Utility function testing
• API route validation testing

End-to-End Testing

# Run E2E tests
npm run test:e2e

Uses Playwright for:

• Critical user flow testing
• Cross-browser testing (Chrome, Firefox, Safari, Edge)
• API integration testing

API Testing

# Run API tests
npm run test:api

Uses Mocha/Chai for:

• REST endpoint testing
• Database integration testing
• Authentication flow testing

Running All Tests

# Run all tests
npm test

Building for Production