tfrere's picture
update
66c8843

Comic Book Generator - Client

Frontend interface for the Comic Book Generator, built with React and Vite.

๐Ÿ› ๏ธ Technologies

  • React 18
  • Vite
  • Material-UI (MUI)
  • Framer Motion
  • React Router
  • Context API

๐Ÿ“ Project Structure

src/
โ”œโ”€โ”€ components/     # Reusable components
โ”‚   โ”œโ”€โ”€ GameNavigation/    # Game navigation
โ”‚   โ”œโ”€โ”€ StoryChoices/      # Choice interface
โ”‚   โ””โ”€โ”€ TalkWithSarah/     # AI Assistant
โ”œโ”€โ”€ contexts/       # React contexts (Game, Sound)
โ”œโ”€โ”€ hooks/          # Custom hooks
โ”œโ”€โ”€ layouts/        # Layout components
โ”œโ”€โ”€ pages/          # Application pages
โ””โ”€โ”€ utils/          # Utilities and API

๐ŸŽฎ Key Features

  • Interactive comic book interface
  • Choice system (predefined or custom)
  • Voice narration with controls
  • Sound effects and ambient music
  • AI Assistant "Sarah" for help
  • Responsive design

๐Ÿš€ Installation

# Install dependencies
yarn install

# Start development server
yarn dev

# Build for production
yarn build

๐Ÿ”ง Configuration

The client requires a running backend server. Configure the API URL in src/utils/api.js.

๐Ÿ“ Testing

# Run tests
yarn test

# Run tests with coverage
yarn test:coverage

๐ŸŽจ Style and Linting

The project uses ESLint and Prettier to maintain clean and consistent code.

# Check style
yarn lint

# Auto-fix issues
yarn lint:fix