Skip to content

Commit 6bce5ed

Browse files
committed
enhancement: made setup process easier by including comments and vars to guide newcommers
1 parent 27679ca commit 6bce5ed

File tree

5 files changed

+54
-14
lines changed

5 files changed

+54
-14
lines changed

.env.example

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
AUTH_SECRET="" # A random string
2-
AUTH_URL="" # Should be http://localhost:3000 for local development
3-
AUTH_GITHUB_ID=""
4-
AUTH_GITHUB_SECRET=""
5-
XATA_API_KEY=""
6-
XATA_BRANCH="" # Default should be "main"
1+
AUTH_SECRET="local-secret" # A random string
2+
AUTH_URL="http://localhost:3000" # Should be http://localhost:3000 for local development
3+
AUTH_GITHUB_ID="" # your github id
4+
AUTH_GITHUB_SECRET="" # your github client secret
5+
XATA_API_KEY="" # xata api key
6+
XATA_BRANCH="main" # Default should be "main"
7+
8+
XATA_HTTP_ENDPOINT="http://localhost"
79

810
NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME="" # Optional
9-
NEXT_PUBLIC_ANALYTICS_WEBSITE_ID="" # Optional
11+
NEXT_PUBLIC_ANALYTICS_WEBSITE_ID="00000000-0000-0000-0000-000000000000" # mandatory so put this value dont change it

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,10 @@ AUTH_GITHUB_SECRET=""
9090
XATA_API_KEY=""
9191
XATA_BRANCH="" # Default should be "main"
9292

93+
XATA_HTTP_ENDPOINT="http://localhost" # Add this too for local development otherwise xata gives error while pnpm run dev
94+
9395
NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME="" # Optional
94-
NEXT_PUBLIC_ANALYTICS_WEBSITE_ID="" # Optional
96+
NEXT_PUBLIC_ANALYTICS_WEBSITE_ID="" # Mandatory for local add : 00000000-0000-0000-0000-000000000000
9597
```
9698

9799
Make sure to fill in the required values for each variable. The `AUTH_SECRET` should be a random string, and `AUTH_URL` should be set to `http://localhost:3000` for local development. The `XATA_BRANCH` should typically be set to "main" unless you're using a different branch.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"@types/react": "^19.1.9",
2121
"@types/twuni__emojify": "^1.0.2",
2222
"@xata.io/cli": "^0.16.12",
23-
"@xata.io/client": "^0.30.1",
23+
"@xata.io/client": "0.0.0-next.v93343b9646f57a1e5c51c35eccf0767c2bb80baa",
2424
"autoprefixer": "^10.4.21",
2525
"axios": "^1.11.0",
2626
"class-variance-authority": "^0.7.1",

pnpm-lock.yaml

Lines changed: 14 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/xata.js

Lines changed: 27 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)