screenshot-to-code

(β˜… 74,308)

Drop in a screenshot and convert it to clean code (HTML/Tailwind/React/Vue)

  • .gitattributes
  • .gitignore
  • AGENTS.md
  • CLAUDE.md
  • docker-compose.yml
  • Evaluation.md
  • LICENSE
  • package.json
  • plan.md
  • QA.md
  • README.md
  • TESTING.md
  • Troubleshooting.md

# Installation Guide

1. Get the code
git clone https://github.com/abi/screenshot-to-code

Downloads the entire project code from GitHub to your computer.

cd screenshot-to-code

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker-compose up -d --build

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
pnpm install

Downloads and installs the libraries listed in package.json.

pnpm dev

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
poetry install

Installs the libraries listed in pyproject.toml.

poetry run playwright install chromium

Type this command into your terminal and run it.

poetry env activate

Type this command into your terminal and run it.

poetry run uvicorn main:app --reload --port 7001

Type this command into your terminal and run it.

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation