Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 1.87 KB

README.md

File metadata and controls

46 lines (33 loc) · 1.87 KB

Write and Run

Write and Run is a platform designed to streamline the process of practicing handwritten code by transforming it into executable programs. It eliminates inefficiencies in testing and debugging, enabling students to prepare more effectively for coding exams.

This project was created in a 36 hour timespan and submitted as a part of the McGill CodeJam Hackathon, winning the "Best use of AI" award. The Devpost submission can be found here.

Project Structure

  • Frontend

  • Backend

    • Developed with Flask for API logic.
    • Utilizes Supabase for user data and test results.
    • Incorporates the OpenAI API for optical character recognition (OCR) and code analysis.

  • Containerization and Hosting

    • Docker ensures consistent builds and deployments.
    • Frontend is hosted on Vercel, and backend is hosted on Google Cloud.

  • Languages Supported

    • Java, C, Bash, and Python.

Write and Run simplifies the journey from handwritten code to execution, helping students master coding under exam conditions.

How to Run

Frontend

The frontend is built using Vite, React, and Tailwind CSS. To start the development server:

cd frontend
npm install
npm run dev

API

The backend API is powered by Flask and requires an OpenAI API key for code analysis and OCR. To set up and run the backend:

export OPENAI_API_KEY="your_openai_api_key"
cd api
pip install -r requirements.txt
python3 app.py