screenshot-to-code README

The project's README from github.com/abi/screenshot-to-code. As one markdown file: README.md.

screenshot-to-code

Convert screenshots, mockups, Figma designs, and screen recordings into clean, functional code using AI. The easiest way to try this is using the official, hosted product at screenshottocode.com →

https://github.com/user-attachments/assets/ec08a5e6-9606-41c5-b03a-1bf47dfeba75

Supported stacks:

Default AI models:

See the Examples section below for more demos.

Screenshot to Code also supports taking a screen recording of a website in action and turning that into a functional prototype.

google in app quick 3

🛠 Getting Started

Choose the path that fits what you want to do:

Running locally requires API keys and a backend/frontend setup. The app has a React/Vite frontend and a FastAPI backend.

API keys

You need at least one model provider key (OpenAI, Anthropic, or Gemini). Gemini and Replicate are strongly recommended for the best quality of screenshot-to-code accuracy — Gemini powers asset extraction (reusing the real logos/images from your screenshot) and Replicate powers image generation, background removal, and image editing. Adding all four keys gives the best results and lets you compare multiple models per generation.

Key Required? What it unlocks
OPENAI_API_KEY One of these three GPT code-gen variants (GPT-5.5, GPT-5.4 Mini)
ANTHROPIC_API_KEY One of these three Claude code-gen variants (Opus 5, Opus 4.8, Fable 5, Sonnet 4.6)
GEMINI_API_KEY One of these three — strongly recommended Gemini code-gen variants (3 Flash, 3.1 Pro); extracts real assets from the screenshot; required for video mode
REPLICATE_API_KEY Strongly recommended Image editing, background removal, and Replicate-backed image generation — without it, edit_images and remove_backgrounds are unavailable

With more keys, the app automatically picks a stronger mix of models per variant; with a single key it uses that provider's models only.

If you'd like to run the app with Ollama open-source models (not recommended due to poor-quality results), follow this comment.

Run the backend (I use Poetry for package management; run pip install --upgrade poetry if you don't have it):

cd backend
echo "OPENAI_API_KEY=sk-your-key" > .env
echo "ANTHROPIC_API_KEY=your-key" >> .env
echo "GEMINI_API_KEY=your-key" >> .env
echo "REPLICATE_API_KEY=r8_your-key" >> .env
poetry install
# Install the Chromium browser used by the screenshot preview tool.
# On Linux, use `poetry run playwright install --with-deps chromium` to also
# install the required system libraries (needs sudo/apt).
poetry run playwright install chromium
poetry env activate
# run the printed command, e.g. source /path/to/venv/bin/activate
poetry run uvicorn main:app --reload --port 7001

You can also set up OpenAI, Anthropic, and Gemini keys using the settings dialog in the frontend (click the gear icon after loading the app). Replicate must be configured in backend/.env as REPLICATE_API_KEY. The Settings dialog also shows whether screenshot preview is available on your backend.

Screenshot preview (optional) lets the agent render its own generated page in a headless browser and visually check its work. It's enabled automatically once Chromium is installed (the playwright install chromium step above, or automatically in the Docker image). If Chromium is missing, the app just skips the tool — the Settings dialog shows whether it's available.

Run the frontend:

cd frontend
pnpm install
pnpm dev

Open http://localhost:5173 to use the app.

If you prefer to run the backend on a different port, update VITE_WS_BACKEND_URL in frontend/.env.local.

Docker

If you have Docker installed, run this from the root directory:

echo "OPENAI_API_KEY=sk-your-key" > .env
docker-compose up -d --build

The app will be up and running at http://localhost:5173. Note that you can't develop the application with this setup, as file changes won't trigger a rebuild.

🙋‍♂️ FAQs

📚 Examples

NYTimes

Original Replica
Screenshot 2023-11-20 at 12 54 03 PM Screenshot 2026-06-15 at 3 06 37 PM

Instagram

https://github.com/user-attachments/assets/a335a105-f9cc-40e6-ac6b-64e5390bfc21

Hacker News

https://github.com/user-attachments/assets/205cb5c7-9c3c-438d-acd4-26dfe6e077e5

screenshot-to-code (abi/screenshot-to-code)

figma
Searching Database…

80.4K ·GitHub
Screenshot-to-code
What is this?Screenshot-to-code converts screenshots, mockups, Figma designs, and screen recordings into clean, functional code using AI models like GPT, Claude, and Gemini.
Is this a hosted web app or something I run myself?Both: there's a hosted product at screenshottocode.com for quick use, or you can run it locally with a React/Vite frontend and a FastAPI backend to self-host and customize it.
How do I get it running locally?Run the backend with Poetry (pip install --upgrade poetry) and run the Vite frontend separately, or use the included Docker setup to bring up the whole app at once.
Do I need API keys for OpenAI, Anthropic, or Gemini?Yes, you need at least one of OPENAI_API_KEY, ANTHROPIC_API_KEY, or GEMINI_API_KEY; Gemini and Replicate keys are strongly recommended for best quality and asset extraction.
Can I use free local models instead of paid APIs?Ollama open-source models are supported but not recommended because they produce poor-quality results compared to the default commercial models.
Does this run on Windows as well as Mac/Linux?Yes, it works cross-platform; the README even notes a Windows-specific fix for UTF-8 encoding errors when editing the .env file.
Which output stacks are supported?HTML+Tailwind, HTML+CSS, React+Tailwind, Vue+Tailwind, Bootstrap, and Ionic+Tailwind.
Can it turn a screen recording into code too?Yes, it also supports taking a screen recording of a website in action and turning it into a functional prototype.
Does it just generate code blindly, or can it check its own work?With Chromium installed (via Playwright or automatically in the Docker image), the agent can render its generated page in a headless browser and visually verify the result.
What is Replicate used for in this project?Replicate powers image editing, background removal, and AI image generation features like the z-image-turbo model, which are unavailable without a REPLICATE_API_KEY.
What are similar projects?gpt4free, openui, onlook, gemini-fullstack-langgraph-quickstart, scira, draw-a-ui, LibreChat, rankme.fast
Which topics is it in?design-to-code, figma, screenshot, code-generation, fastapi, gpt, tailwindcss, vite, chatbot, vue, gemini, docker-compose
Creator
abi
Size
10.9 MB
Stars
80.4K
Updated
CommitOct 09
Age
2y
Commits · 90 Days