Skip to content

Commit bbaad1a

Browse files
feat: add sparse checkout instructions to all template examples
- React SDK Demo: add Option 1 (Full Clone) and Option 2 (Sparse Checkout) - Social Media Clone: add Option 1 (Full Clone) and Option 2 (Sparse Checkout) - Python SDK Demo: add Option 1 (Full Clone) and Option 2 (Sparse Checkout) - All templates now recommend sparse checkout for faster setup
1 parent 6d932db commit bbaad1a

1 file changed

Lines changed: 66 additions & 0 deletions

File tree

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

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,33 @@ const TEMPLATES = [
2121
A minimal React app demonstrating \`@urbackend/react\` components.
2222
2323
## Setup
24+
25+
### Option 1: Full Clone
2426
\`\`\`bash
2527
git clone https://github.com/geturbackend/urBackend.git
2628
cd urBackend/examples/react-sdk-demo
2729
npm install
2830
\`\`\`
2931
32+
### Option 2: Sparse Checkout (Recommended)
33+
Clone only this template folder without downloading the entire repository:
34+
\`\`\`bash
35+
# Clone repository without files
36+
git clone --no-checkout --depth 1 https://github.com/geturbackend/urBackend.git react-sdk-demo
37+
cd react-sdk-demo
38+
39+
# Enable sparse-checkout
40+
git sparse-checkout init --cone
41+
42+
# Checkout only the react-sdk-demo template folder
43+
git sparse-checkout set examples/react-sdk-demo
44+
45+
# Download the files
46+
git checkout main
47+
48+
npm install
49+
\`\`\`
50+
3051
1. Copy \`VITE_URBACKEND_PK\` from your project's API keys
3152
2. Run \`npm run dev\` to start the development server
3253
`
@@ -107,6 +128,30 @@ git checkout main
107128
A full Twitter/X.com clone built on urBackend.
108129
109130
## Setup
131+
132+
### Option 1: Full Clone
133+
\`\`\`bash
134+
git clone https://github.com/geturbackend/urBackend.git
135+
cd urBackend/examples/social-demo
136+
\`\`\`
137+
138+
### Option 2: Sparse Checkout (Recommended)
139+
Clone only this template folder without downloading the entire repository:
140+
\`\`\`bash
141+
# Clone repository without files
142+
git clone --no-checkout --depth 1 https://github.com/geturbackend/urBackend.git social-demo
143+
cd social-demo
144+
145+
# Enable sparse-checkout
146+
git sparse-checkout init --cone
147+
148+
# Checkout only the social-demo template folder
149+
git sparse-checkout set examples/social-demo
150+
151+
# Download the files
152+
git checkout main
153+
\`\`\`
154+
110155
1. Enable Auth with GitHub/Google social login
111156
2. Create required collections: \`posts\`, \`profiles\`, \`comments\`, \`likes\`, \`follows\`
112157
3. Configure RLS for each collection
@@ -130,10 +175,31 @@ A full Twitter/X.com clone built on urBackend.
130175
A CLI-based demo of the urbackend Python SDK.
131176
132177
## Setup
178+
179+
### Option 1: Full Clone
133180
\`\`\`bash
134181
git clone https://github.com/geturbackend/urBackend.git
135182
cd urBackend/examples/python-sdk-demo
183+
\`\`\`
184+
185+
### Option 2: Sparse Checkout (Recommended)
186+
Clone only this template folder without downloading the entire repository:
187+
\`\`\`bash
188+
# Clone repository without files
189+
git clone --no-checkout --depth 1 https://github.com/geturbackend/urBackend.git python-sdk-demo
190+
cd python-sdk-demo
191+
192+
# Enable sparse-checkout
193+
git sparse-checkout init --cone
136194
195+
# Checkout only the python-sdk-demo template folder
196+
git sparse-checkout set examples/python-sdk-demo
197+
198+
# Download the files
199+
git checkout main
200+
\`\`\`
201+
202+
\`\`\`bash
137203
pip install -r requirements.txt
138204
cp .env.example .env
139205
# Edit .env with your API keys

0 commit comments

Comments
 (0)