Skip to content

Commit 9cca8dd

Browse files
feat: add directory navigation and env setup for all template examples
- React SDK Demo: add cd examples/react-sdk-demo before npm install, update to VITE_UR_PUBLIC_KEY - Kanban Board: add cd examples/sdk-kanban before environment setup - Social Media Clone: add cd examples/social-demo, add env vars (VITE_PUBLIC_KEY, API_KEY) and run instructions - Python SDK Demo: add cd examples/python-sdk-demo before pip install - All templates now have consistent sparse checkout + directory navigation flow
1 parent bbaad1a commit 9cca8dd

1 file changed

Lines changed: 31 additions & 2 deletions

File tree

apps/web-dashboard/src/pages/Templates.jsx

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,15 @@ git sparse-checkout set examples/react-sdk-demo
4444
4545
# Download the files
4646
git checkout main
47+
\`\`\`
4748
49+
After cloning, navigate to the template directory and install dependencies:
50+
\`\`\`bash
51+
cd examples/react-sdk-demo
4852
npm install
4953
\`\`\`
5054
51-
1. Copy \`VITE_URBACKEND_PK\` from your project's API keys
55+
1. Copy \`VITE_UR_PUBLIC_KEY\` from your project's API keys and place it in the client \`.env\` file
5256
2. Run \`npm run dev\` to start the development server
5357
`
5458
},
@@ -93,6 +97,11 @@ git sparse-checkout set examples/sdk-kanban
9397
git checkout main
9498
\`\`\`
9599
100+
After cloning, navigate to the template directory and set up the project:
101+
\`\`\`bash
102+
cd examples/sdk-kanban
103+
\`\`\`
104+
96105
1. Enable Auth in your urBackend project
97106
2. Create collections with RLS:
98107
- \`boards\`: \`name\` (String, Required), \`ownerId\` (String, Required). Mode: \`private\`, ownerField: \`ownerId\`
@@ -152,10 +161,25 @@ git sparse-checkout set examples/social-demo
152161
git checkout main
153162
\`\`\`
154163
164+
After cloning, navigate to the template directory and set up the project:
165+
\`\`\`bash
166+
cd examples/social-demo
167+
\`\`\`
168+
155169
1. Enable Auth with GitHub/Google social login
156170
2. Create required collections: \`posts\`, \`profiles\`, \`comments\`, \`likes\`, \`follows\`
157171
3. Configure RLS for each collection
158-
4. Deploy or run locally.
172+
4. Configure environment variables:
173+
- Copy \`client/.env.example\` to \`client/.env\` and set \`VITE_PUBLIC_KEY=pk_live_...\`
174+
- Copy \`server/.env.example\` to \`server/.env\` and set \`API_KEY=sk_live_...\`
175+
5. Run the application:
176+
\`\`\`bash
177+
# Terminal 1: Start proxy server
178+
cd server && npm install && npm start
179+
180+
# Terminal 2: Start client
181+
cd client && npm install && npm run dev
182+
\`\`\`
159183
`
160184
},
161185
{
@@ -199,6 +223,11 @@ git sparse-checkout set examples/python-sdk-demo
199223
git checkout main
200224
\`\`\`
201225
226+
After cloning, navigate to the template directory and set up the project:
227+
\`\`\`bash
228+
cd examples/python-sdk-demo
229+
\`\`\`
230+
202231
\`\`\`bash
203232
pip install -r requirements.txt
204233
cp .env.example .env

0 commit comments

Comments
 (0)