Update README.md

This commit is contained in:
Lu Wilson 2024-01-18 12:32:11 +00:00 committed by GitHub
parent 07bab3fa91
commit 8238eef9a9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 54 additions and 4 deletions

View File

@ -1,11 +1,61 @@
## draw fast
# draw fast
Get a key from https://www.fal.ai/dashboard/keys and add it to `.env.local`
**Draw Fast** is a demo that shows how you can use the [**tldraw library**](https://tldraw.dev) with realtime image generation. The demo has now finished and weve taken it down. But you can still run it on your own machine and try it out.
Then just...
Heres how:
```bash
## 1. Clone the repo
Clone the [Draw Fast repo](https://github.com/tldraw/draw-fast) from github.
https://github.com/tldraw/draw-fast
## 2. Get a Fal key
Go to [fal.ai](https://fal.ai)
Login with github, and get a key from the [keys page](https://www.fal.ai/dashboard/keys). (You can give it any name you want).
![Untitled](https://prod-files-secure.s3.us-west-2.amazonaws.com/caa9ce5f-2803-48f0-a148-84fb1782a8cb/e44ea754-1155-4693-ba2c-31fb8fb5914c/Untitled.png)
Copy your key.
![Untitled](https://prod-files-secure.s3.us-west-2.amazonaws.com/caa9ce5f-2803-48f0-a148-84fb1782a8cb/12814028-825f-4e8a-9ac8-9b622cbab879/Untitled.png)
## 3. Setup environment variables
Create a `.env` file in the root folder of your repo.
Paste your key there as `FAL_KEY`
Your file should something like this:
```
FAL_KEY=8bf6c68d-8711-426b-90c6-0d9636909fce:b774f2a649cfecbf56dce57db7966a73
```
## 4. Run it locally
In your terminal…
```
npm install
npm run dev
```
And open `localhost:3000`
## 5. Draw fast
Draw something in the rectangle!
Double-clicking the prompt to change it.
Click the small arrow to enter *lens mode*.
## 6. Share!
Record your screen and show us what you draw fast.
Were [@tldraw on twitter](https://twitter.com/tldraw).
## Troubleshooting
If the generated images dont appear, try running `npm install` and `npm run dev` again, or try waiting a while for your key to activate.