Github/screenshot-to-code
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

simplify README

Browse Source
This commit is contained in:
Abi Raja 2023-11-19 21:43:41 -05:00
parent 63add37505
commit 18330954e7
1 changed files with 7 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -8,9 +8,8 @@ See Examples section below for more demos.
## Updates ## Updates
* Nov 16 - View code directly within the app - Nov 16 - View code directly within the app
* Nov 15 - 🔥 You can now instruct the AI to update the code as you wish. Useful if the AI messed up some styles or missed a section. - Nov 15 - 🔥 You can now instruct the AI to update the code as you wish. Useful if the AI messed up some styles or missed a section.
## Getting Started ## Getting Started
@ -40,20 +39,17 @@ If you prefer to run the backend on a different port, update VITE_WS_BACKEND_URL
## Docker ## Docker
If you have Docker installed on your system, you can get started quickly with:
```bash ```bash
echo "OPENAI_API_KEY=sk-your-key" > .env echo "OPENAI_API_KEY=sk-your-key" > .env
docker-compose up -d --build docker-compose up -d --build
``` ```
If you want to change the backend port to something other than 7000 (default) - for example, 7001. Then:
1. `echo "BACKEND_PORT=7001"`
2. `echo VITE_WS_BACKEND_URL=ws://127.0.0.1:7001 > frontend/.env.local`
Port 7000 sometimes is used by Airplay if you are on a mac. This will solve the docker error "Ports are not available... address already in use"
Application will be up and running at http://localhost:5173 Application 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.
## Feedback ## Feedback
If you have feature requests, bug reports or other feedback, open an issue or ping me on [Twitter](https://twitter.com/_abi_). If you have feature requests, bug reports or other feedback, open an issue or ping me on [Twitter](https://twitter.com/_abi_).
@ -64,7 +60,6 @@ Hacker News but it gets the colors wrong at first so we nudge it
https://github.com/abi/screenshot-to-code/assets/23818/3fec0f77-44e8-4fb3-a769-ac7410315e5d https://github.com/abi/screenshot-to-code/assets/23818/3fec0f77-44e8-4fb3-a769-ac7410315e5d
## Hosted Version ## Hosted Version
Hosted version coming soon on [Pico](https://picoapps.xyz?ref=github). Hosted version coming soon on [Pico](https://picoapps.xyz?ref=github).