diff --git a/README.md b/README.md index d744478..77c93ed 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ https://github.com/abi/screenshot-to-code/assets/23818/6cebadae-2fe3-4986-ac6a-8 Supported stacks: - HTML + Tailwind +- HTML + CSS - React + Tailwind - Vue + Tailwind - Bootstrap @@ -24,7 +25,7 @@ Supported AI models: See the [Examples](#-examples) section below for more demos. -We also just added experimental support for taking a video/screen recording of a website in action and turning that into a functional prototype. +We also just added experimental support for taking a video/screen recording of a website in action and turning that into a functional prototype. ![google in app quick 3](https://github.com/abi/screenshot-to-code/assets/23818/8758ffa4-9483-4b9b-bb66-abd6d1594c33) @@ -42,12 +43,12 @@ We also just added experimental support for taking a video/screen recording of a ## 🛠 Getting Started -The app has a React/Vite frontend and a FastAPI backend. +The app has a React/Vite frontend and a FastAPI backend. Keys needed: -* [OpenAI API key with access to GPT-4](https://github.com/abi/screenshot-to-code/blob/main/Troubleshooting.md) -* Anthropic key (optional) - only if you want to use Claude Sonnet, or for experimental video support. +- [OpenAI API key with access to GPT-4](https://github.com/abi/screenshot-to-code/blob/main/Troubleshooting.md) +- Anthropic key (optional) - only if you want to use Claude Sonnet, or for experimental video support. Run the backend (I use Poetry for package management - `pip install poetry` if you don't have it): @@ -94,9 +95,9 @@ The app will be up and running at http://localhost:5173. Note that you can't dev - **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 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. +- **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 diff --git a/frontend/src/lib/stacks.ts b/frontend/src/lib/stacks.ts index 6fe22e0..89515db 100644 --- a/frontend/src/lib/stacks.ts +++ b/frontend/src/lib/stacks.ts @@ -1,7 +1,8 @@ // Keep in sync with backend (prompts/types.py) +// Order here determines order in dropdown export enum Stack { - HTML_CSS = "html_css", HTML_TAILWIND = "html_tailwind", + HTML_CSS = "html_css", REACT_TAILWIND = "react_tailwind", BOOTSTRAP = "bootstrap", VUE_TAILWIND = "vue_tailwind",