Skip to content

Latest commit

 

History

History
23 lines (20 loc) · 1003 Bytes

File metadata and controls

23 lines (20 loc) · 1003 Bytes

StudyBytes Project Guidelines

Project Overview

AI-powered platform converting learning materials into engaging, short-form educational videos tailored to students' learning needs.

Commands

  • Setup: npm install
  • Dev server: npm run dev
  • Build: npm run build
  • Lint: npm run lint
  • Test: npm test
  • Single test: npm test -- -t "test name"

Code Style Guidelines

  • Framework: React with Next.js for frontend
  • Styling: Tailwind CSS for styling components
  • State Management: React Context API for state management
  • API Calls: Use fetch API or axios for API calls
  • Naming: camelCase for variables/functions, PascalCase for components
  • Error Handling: Try/catch blocks with meaningful error messages
  • Component Structure: Modular components with clear separation of concerns
  • Imports: Group imports by external packages, then internal components
  • File Organization: Feature-based organization with shared components