Skip to content

Commit 9e8c66b

Browse files
committed
readme update
1 parent 2db9af3 commit 9e8c66b

1 file changed

Lines changed: 12 additions & 5 deletions

File tree

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,18 @@ VITE_BTC_CONFIRMATIONS=6
9494
9595
# Default position id for reservation
9696
VITE_DEFAULT_POSITION_ID=
97+
98+
# Netlify site id
99+
NETLIFY_SITE_ID
100+
101+
# Personal auth token
102+
NETLIFY_AUTH_TOKEN
97103
```
98104

105+
### How to obtain these variables from Netlify
106+
- **NETLIFY_SITE_ID:** Go to your site in the Netlify dashboard, then navigate to Site settings > General > Site details. The Site ID (API ID) will be listed there.
107+
- **NETLIFY_AUTH_TOKEN:** Go to https://app.netlify.com/user/applications and create a new Personal access token. Copy and use this token as your NETLIFY_AUTH_TOKEN.
108+
99109
## Contract Addresses Configuration
100110
The application uses different contract addresses for different networks. These addresses are configured in `src/constants/contracts.ts`. To modify the contract addresses:
101111

@@ -130,12 +140,8 @@ npm run test
130140
# Run tests with coverage
131141
npm run test:coverage
132142
```
133-
134143
## Deployment
135-
The project is deployed using github actions and netlify. Set the followings actions variables in order to correctly deploy to netlify:
136-
137-
NETLIFY_SITE_ID
138-
NETLIFY_AUTH_TOKEN
144+
The project is deployed using github actions and netlify. All the previously mentioned env variables must be added to the actions secrets on github.
139145

140146
### Continuous deployment trigger
141147
On every new commit to `develop` (netflify preview) and `main` (netlify production)
@@ -148,3 +154,4 @@ On every new commit to `develop` (netflify preview) and `main` (netlify producti
148154

149155
## License
150156
[Add your license information here]
157+

0 commit comments

Comments
 (0)