Skip to content

Commit 73e6d36

Browse files
fix: update clone instructions and SDK dependencies for all examples
- Python SDK Demo README: add urBackend/ prefix to cd path - Social Demo README: fix repo URL to geturbackend/urBackend, add urBackend/ prefix - Kanban README: add clone instructions with urBackend/ prefix - Kanban server: replace file: SDK dependency with published 0.4.2 - Templates.jsx: update all readme blocks with correct clone + cd instructions
1 parent a251cf3 commit 73e6d36

5 files changed

Lines changed: 34 additions & 14 deletions

File tree

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

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,14 @@ const TEMPLATES = [
2121
A minimal React app demonstrating \`@urbackend/react\` components.
2222
2323
## Setup
24+
\`\`\`bash
25+
git clone https://github.com/geturbackend/urBackend.git
26+
cd urBackend/examples/react-sdk-demo
27+
npm install
28+
\`\`\`
29+
2430
1. Copy \`VITE_URBACKEND_PK\` from your project's API keys
25-
2. Deploy with the button above or run locally:
26-
\`\`\`bash
27-
cd examples/react-sdk-demo
28-
npm install
29-
npm run dev
30-
\`\`\`
31+
2. Run \`npm run dev\` to start the development server
3132
`
3233
},
3334
{
@@ -47,10 +48,20 @@ A minimal React app demonstrating \`@urbackend/react\` components.
4748
A Kanban board app using \`@urbackend/sdk\` for data and auth.
4849
4950
## Setup
51+
\`\`\`bash
52+
git clone https://github.com/geturbackend/urBackend.git
53+
cd urBackend/examples/sdk-kanban
54+
55+
# Terminal 1: Start server
56+
cd server && npm install && npm start
57+
58+
# Terminal 2: Start client
59+
cd client && npm install && npm run dev
60+
\`\`\`
61+
5062
1. Enable Auth in your urBackend project
5163
2. Create \`boards\` and \`tasks\` collections with RLS
5264
3. Copy \`VITE_URBACKEND_PK\` from your API keys
53-
4. Deploy or run locally.
5465
`
5566
},
5667
{
@@ -94,7 +105,9 @@ A CLI-based demo of the urbackend Python SDK.
94105
95106
## Setup
96107
\`\`\`bash
97-
cd examples/python-sdk-demo
108+
git clone https://github.com/geturbackend/urBackend.git
109+
cd urBackend/examples/python-sdk-demo
110+
98111
pip install -r requirements.txt
99112
cp .env.example .env
100113
# Edit .env with your API keys

‎examples/python-sdk-demo/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ A minimal Python application demonstrating the `urbackend` Python SDK for databa
1414
```bash
1515
# Clone the repo
1616
git clone https://github.com/geturbackend/urBackend.git
17-
cd examples/python-sdk-demo
17+
cd urBackend/examples/python-sdk-demo
1818

1919
# Create virtual environment
2020
python -m venv venv

‎examples/sdk-kanban/README.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,14 @@ A modern Kanban Board application demonstrating the official `@urbackend/sdk`.
99

1010
## 🚀 Getting Started
1111

12-
### 1. Dashboard Setup
12+
### 1. Clone the Repository
13+
14+
```bash
15+
git clone https://github.com/geturbackend/urBackend.git
16+
cd urBackend/examples/sdk-kanban
17+
```
18+
19+
### 2. Dashboard Setup
1320
1. **Enable Auth**: Go to 'Auth' in your urBackend project and toggle it on.
1421
2. **Create Collections**:
1522
- `boards`: Add field `name` (String, Required) and `ownerId` (String, Required).

‎examples/sdk-kanban/server/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"dev": "nodemon index.js"
1010
},
1111
"dependencies": {
12-
"@urbackend/sdk": "file:../../../sdks/urbackend-sdk",
12+
"@urbackend/sdk": "0.4.2",
1313
"cors": "^2.8.5",
1414
"dotenv": "^16.4.5",
1515
"express": "^4.19.2"

‎examples/social-demo/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ A **full-featured X.com (Twitter) clone** built entirely on the **urBackend** Ba
3434
### 2. Installation
3535
```bash
3636
# Clone the repository
37-
git clone https://github.com/yash-pouranik/urBackend.git
38-
cd examples/social-demo
37+
git clone https://github.com/geturbackend/urBackend.git
38+
cd urBackend/examples/social-demo
3939

4040
# Install dependencies for both Client and Proxy Server
4141
cd client && npm install
@@ -283,4 +283,4 @@ For each writable collection (`posts`, `comments`, `likes`, `follows`, `profiles
283283
---
284284

285285
Built with ❤️ by the **urBackend** Community.
286-
[Discord](https://discord.gg/CXJjvJkNWn) | [Documentation](https://github.com/yash-pouranik/urBackend/tree/main/docs)
286+
[Discord](https://discord.gg/CXJjvJkNWn) | [Documentation](https://github.com/geturbackend/urBackend/tree/main/docs)

0 commit comments

Comments
 (0)