Skip to content

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

Python

Update README.md

Abi Rajae2dc80f47dab
diff --git a/README.md b/README.md
index 4ec096f9..7b3be49c 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,30 @@
-[Video Demo]
+# screenshot-to-html
-### Instructions
+This is a simple app that converts a screenshot to HTML (uses Tailwind CSS). It uses GPT-4 Vision to generate the code.
-Run the backend
+[Video GIF]
-```bash
-poetry install
-poetry run uvicorn main:app --reload --port 7000
-```
+## Getting Started
+
+The app has a React/Vite front-end and a FastAPI backend. You will need an OpenAI API key with access to the GPT-4 Vision API.
-Run the frontend,
+In the root directory,
```bash
+cd backend
+echo "OPENAI_API_KEY=sk-your-key" > .env
+poetry install
+poetry run uvicorn main:app --reload --port 7000
+cd ..
+cd frontend
yarn
yarn dev
```
-## Hosted Version
+Open http://localhost:5173 to use the app.
-Hosted version coming soon at https://picoapps.xyz
+If you prefer to run the backend on a different port, just modify VITE_WS_BACKEND_URL=ws://127.0.0.1:7000 in .env.local.
-### Environment Variables
+## Hosted Version
-.env.local contains
-VITE_WS_BACKEND_URL=ws://127.0.0.1:7000
+Hosted version coming soon at https://picoapps.xyz