Skip to content

Commit 2f2cd5a

Browse files
committed
update README + gitignore for hey-api logs
1 parent b7e97de commit 2f2cd5a

2 files changed

Lines changed: 18 additions & 6 deletions

File tree

β€Ž.gitignoreβ€Ž

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ tsconfig.tsbuildinfo
4949
.env.test.local
5050
.env.production.local
5151

52+
# hey-api
53+
src/lib/hey-api/generated/*
54+
openapi-ts-error-*.log
5255

53-
.tanstack
54-
src/lib/hey-api/generated/*
56+
.tanstack

β€ŽREADME.mdβ€Ž

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,25 @@ cp .vscode/settings.example.json .vscode/settings.json # (Optionnal) Setup your
2929
pnpm install # Install dependencies
3030
```
3131

32-
## Connect to your API
32+
## Environment variables
3333

34-
Using Hey API, you can quickly connect your app with any REST API. Just put your openapi url as `EXPO_PUBLIC_OPENAPI_URL` environment variable and run
34+
🚨 Using Expo Go, should not be `localhost`, use public IP instead
35+
36+
```bash
37+
EXPO_PUBLIC_BASE_URL # Base URL of your server, usefull if you are using Start UI [web]
38+
39+
# OPTIONAL TO OVERRIDE
40+
EXPO_PUBLIC_AUTH_URL # Better-auth url (default `${EXPO_PUBLIC_BASE_URL}/api/auth`)
41+
EXPO_PUBLIC_OPENAPI_URL # OpenAPI contract URL (default `${EXPO_PUBLIC_BASE_URL}/openapi/app/schema`)
42+
```
43+
44+
## API SDK generation
3545

3646
```bash
3747
pnpm gen:api
3848
```
3949

40-
A new folder `/src/lib/hey-api/generated` will be created with stuff like to combine use Tanstack Query to fetch data.
50+
A new folder `/src/lib/hey-api/generated` will be created with stuff like to combine use Tanstack Query to fetch data, based on env variables.
4151

4252
For example
4353
```ts
@@ -86,4 +96,4 @@ To be able to use previews on PR, you have to setup your project with EAS
8696
4. Setup eas
8797
* `eas login`
8898
* `eas init --id {projectid}`
89-
* `eas update:configure`
99+
* `eas update:configure`

0 commit comments

Comments
Β (0)