Skip to content

enhancement: made setup process easier by including comments and vars… #234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

enhancement: made setup process easier by including comments and vars… #234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6bce5ed
enhancement: made setup process easier by including comments and vars…
11Warrior Aug 18, 2025
448d8b5
Update .gitignore
11Warrior Aug 23, 2025
58e41ff
Update .gitignore
11Warrior Aug 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
AUTH_SECRET="" # A random string
AUTH_URL="" # Should be http://localhost:3000 for local development
AUTH_GITHUB_ID=""
AUTH_GITHUB_SECRET=""
XATA_API_KEY=""
XATA_BRANCH="" # Default should be "main"
AUTH_SECRET="local-secret" # A random string
AUTH_URL="http://localhost:3000" # Should be http://localhost:3000 for local development
AUTH_GITHUB_ID="" # your github id
AUTH_GITHUB_SECRET="" # your github client secret
XATA_API_KEY="" # xata api key
XATA_BRANCH="main" # Default should be "main"

XATA_HTTP_ENDPOINT="http://localhost"

NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME="" # Optional
NEXT_PUBLIC_ANALYTICS_WEBSITE_ID="" # Optional
NEXT_PUBLIC_ANALYTICS_WEBSITE_ID="00000000-0000-0000-0000-000000000000" # mandatory so put this value dont change it
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
.pnp.js
package-lock.json
.env*
/src/xata.js
/src/xata.ts

# testing
/coverage
Expand Down
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,10 @@ AUTH_GITHUB_SECRET=""
XATA_API_KEY=""
XATA_BRANCH="" # Default should be "main"

XATA_HTTP_ENDPOINT="http://localhost" # Add this too for local development otherwise xata gives error while pnpm run dev

NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME="" # Optional
NEXT_PUBLIC_ANALYTICS_WEBSITE_ID="" # Optional
NEXT_PUBLIC_ANALYTICS_WEBSITE_ID="" # Mandatory for local add : 00000000-0000-0000-0000-000000000000
```

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.
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"@types/react": "^19.1.9",
"@types/twuni__emojify": "^1.0.2",
"@xata.io/cli": "^0.16.12",
"@xata.io/client": "^0.30.1",
"@xata.io/client": "0.0.0-next.v93343b9646f57a1e5c51c35eccf0767c2bb80baa",
"autoprefixer": "^10.4.21",
"axios": "^1.11.0",
"class-variance-authority": "^0.7.1",
Expand Down
19 changes: 14 additions & 5 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

27 changes: 27 additions & 0 deletions src/xata.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.