Drop in a screenshot and convert it to clean code (HTML/Tailwind/React/Vue)
Python
Polish README wording and formatting
Abi Rajabb4c7d8f1476
diff --git a/README.md b/README.mdindex b520f28a..d83b1a8c 100644--- a/README.md+++ b/README.md@@ -15,8 +15,8 @@ Supported stacks:Default AI models:-- Gemini 3 Flash Preview and Gemini 3.1 Pro Preview - best models-- GPT-5.5, GPT-5.2 Codex and GPT-5.4 Mini+- Gemini 3 Flash Preview and Gemini 3.1 Pro Preview - the best models+- GPT-5.5, GPT-5.2 Codex, and GPT-5.4 Mini- Claude Opus 4.6, Claude Opus 4.8- z-image-turbo (using Replicate) for image generation@@ -31,18 +31,18 @@ Screenshot to Code also supports taking a screen recording of a website in actioChoose the path that fits what you want to do:- **Run locally:** best if you want to customize, self-host, or contribute.-- **Use the hosted app:** fastest way to try Screenshot to Code with no local setup. [Open the hosted app →](https://screenshottocode.com/?utm_source=github&utm_medium=readme&utm_campaign=oss_readme&utm_content=getting_started_cta)+- **Use the hosted app:** the fastest way to try Screenshot to Code with no local setup. [Open the hosted app →](https://screenshottocode.com/?utm_source=github&utm_medium=readme&utm_campaign=oss_readme&utm_content=getting_started_cta)Running locally requires API keys and a backend/frontend setup. The app has a React/Vite frontend and a FastAPI backend.Keys needed:-- [OpenAI API key](https://github.com/abi/screenshot-to-code/blob/main/Troubleshooting.md), Anthropic key, or Google Gemini key+- An [OpenAI API key](https://github.com/abi/screenshot-to-code/blob/main/Troubleshooting.md), Anthropic key, or Google Gemini key- Multiple keys are recommended so you can compare results from different models-If you'd like to run the app with Ollama open source models (not recommended due to poor quality results), [follow this comment](https://github.com/abi/screenshot-to-code/issues/354#issuecomment-2435479853).+If you'd like to run the app with Ollama open-source models (not recommended due to poor-quality results), [follow this comment](https://github.com/abi/screenshot-to-code/issues/354#issuecomment-2435479853).-Run the backend (I use Poetry for package management - `pip install --upgrade poetry` if you don't have it):+Run the backend (I use Poetry for package management; run `pip install --upgrade poetry` if you don't have it):```bashcd backend@@ -55,7 +55,7 @@ poetry env activatepoetry run uvicorn main:app --reload --port 7001```-You can also set up the keys using the settings dialog on the front-end (click the gear icon after loading the frontend).+You can also set up the keys using the settings dialog in the frontend (click the gear icon after loading the app).Run the frontend:@@ -67,18 +67,18 @@ yarn devOpen 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`+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 on your system, in the root directory, run:+If you have Docker installed, run this from the root directory:```bashecho "OPENAI_API_KEY=sk-your-key" > .envdocker-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 the file changes won't trigger a rebuild.+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.Want to try it with your own screenshot before setting up locally?@@ -88,10 +88,10 @@ Want to try it with your own screenshot before setting up locally?- **I'm running into an error when setting up the backend. How can I fix it?** [Try this](https://github.com/abi/screenshot-to-code/issues/3#issuecomment-1814777959). If that still doesn't work, open an issue.- **How do I get an OpenAI API key?** See https://github.com/abi/screenshot-to-code/blob/main/Troubleshooting.md-- **How can I configure an OpenAI proxy?** - If you're not able to access the OpenAI API directly (due to e.g. country restrictions), you can try a VPN or you can configure the OpenAI base URL to use a proxy: Set OPENAI_BASE_URL in the `backend/.env` or directly in the UI in the settings dialog. Make sure the URL has "v1" in the path so it should look like this: `https://xxx.xxxxx.xxx/v1`-- **How can I update the backend host that my front-end connects to?** - Configure VITE_HTTP_BACKEND_URL and VITE_WS_BACKEND_URL in front/.env.local For example, set VITE_HTTP_BACKEND_URL=http://124.10.20.1:7001-- **Seeing UTF-8 errors when running the backend?** - On windows, open the .env file with notepad++, then go to Encoding and select UTF-8.-- **How can I provide feedback?** For feedback, feature requests and bug reports, open an issue or ping me on [Twitter](https://twitter.com/_abi_).+- **How can I configure an OpenAI proxy?** If you're not able to access the OpenAI API directly, for example because of country restrictions, you can try a VPN or configure the OpenAI base URL to use a proxy. Set `OPENAI_BASE_URL` in `backend/.env` or directly in the UI in the settings dialog. Make sure the URL has `v1` in the path, for example: `https://xxx.xxxxx.xxx/v1`.+- **How can I update the backend host that my frontend connects to?** Configure `VITE_HTTP_BACKEND_URL` and `VITE_WS_BACKEND_URL` in `frontend/.env.local`. For example, set `VITE_HTTP_BACKEND_URL=http://124.10.20.1:7001`.+- **Seeing UTF-8 errors when running the backend?** On Windows, open the `.env` file with Notepad++, then go to Encoding and select UTF-8.+- **How can I provide feedback?** For feedback, feature requests, and bug reports, open an issue or ping me on [Twitter](https://twitter.com/_abi_).## 📚 Examples