Skip to content

mzhang055/mockmate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 

Repository files navigation

MockMate

A web app that instantly generates LaTeX-formatted mock test PDFs from worksheets and tests.

Features

  • Upload PDF worksheets or tests
  • Paste text content directly
  • AI-powered question extraction and formatting
  • LaTeX output generation
  • PDF preview and download
  • Responsive web interface

Tech Stack

Frontend

  • Next.js 15 - React framework with App Router
  • TypeScript - Type safety
  • Tailwind CSS - Styling
  • Framer Motion - Animations
  • React PDF - PDF rendering
  • Monaco Editor - Code editing

Backend

  • FastAPI - Python web framework
  • Google Gemini - AI service for content processing
  • LaTeX - Document formatting
  • Docker - Containerization

Getting Started

Prerequisites

  • Node.js 18+ and npm
  • Python 3.8+
  • Docker (optional)

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/mockmate.git
cd mockmate
  1. Install frontend dependencies:
cd frontend
npm install
  1. Install backend dependencies:
cd ../backend
pip install -r requirements.txt
  1. Set up environment variables:
# Backend - create .env file
GEMINI_API_KEY=your_gemini_api_key_here

Development

  1. Start the backend server:
cd backend
python main.py
  1. Start the frontend development server:
cd frontend
npm run dev
  1. Open http://localhost:3000 in your browser.

Building for Production

Frontend

cd frontend
npm run build
npm start

Backend

cd backend
# Using Docker
docker build -t mockmate-backend .
docker run -p 8000:8000 mockmate-backend

Project Structure

mockmate/
├── frontend/                 # Next.js frontend application
│   ├── src/
│   │   ├── app/             # App Router pages
│   │   └── components/      # React components
│   ├── public/              # Static assets
│   └── package.json
├── backend/                 # FastAPI backend application
│   ├── api/
│   │   ├── controllers/     # API route handlers
│   │   ├── models/          # Data models
│   │   └── services/        # Business logic
│   ├── latex-service/       # LaTeX processing service
│   └── main.py             # FastAPI app entry point
└── README.md

License

This project is licensed under the MIT License - see the LICENSE file for details.

Deployment

The application is deployed at:

About

Turn worksheets into LaTeX formatted mock tests PDFs ready in seconds

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors