Skip to content

Commit 2d179d7

Browse files
committed
docs: add info about api key
1 parent b437df5 commit 2d179d7

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,20 @@ A showcase application built with Vite and React. Powered by [The Cats API](http
44

55
[Live demo](https://petmemo-sarneeh.vercel.app/)
66

7+
## Prerequisities
8+
9+
Important! Unfortunately the Cats API does not work properly without an API key. If you want to run the app locally, you need to grab a key from the [Cats API](https://thecatapi.com) website and put it in a `.env` file, like this:
10+
11+
```
12+
VITE_API_KEY=YOUR_KEY_HERE
13+
```
14+
15+
### What exactly does not work?
16+
17+
The *limit* query parameter does not work without an API key and always returns 10 entries. I didn't want to hack around this as this is a bad practice.
18+
19+
Example: https://api.thecatapi.com/v1/images/search?limit=2
20+
721
## How to run
822

923
### Run in development mode

0 commit comments

Comments
 (0)