Skip to content

Commit 6d932db

Browse files
feat: add sparse checkout option for Kanban template
- Add Option 1: Full Clone (existing method) - Add Option 2: Sparse Checkout (recommended for faster setup) - Sparse checkout clones only the template folder without full repo
1 parent 0841592 commit 6d932db

1 file changed

Lines changed: 20 additions & 1 deletion

File tree

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

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,30 @@ npm install
4848
A Kanban board app using \`@urbackend/sdk\` for data and auth.
4949
5050
## Setup
51+
52+
### Option 1: Full Clone
5153
\`\`\`bash
5254
git clone https://github.com/geturbackend/urBackend.git
5355
cd urBackend/examples/sdk-kanban
5456
\`\`\`
5557
58+
### Option 2: Sparse Checkout (Recommended)
59+
Clone only this template folder without downloading the entire repository:
60+
\`\`\`bash
61+
# Clone repository without files
62+
git clone --no-checkout --depth 1 https://github.com/geturbackend/urBackend.git sdk-kanban
63+
cd sdk-kanban
64+
65+
# Enable sparse-checkout
66+
git sparse-checkout init --cone
67+
68+
# Checkout only the kanban template folder
69+
git sparse-checkout set examples/sdk-kanban
70+
71+
# Download the files
72+
git checkout main
73+
\`\`\`
74+
5675
1. Enable Auth in your urBackend project
5776
2. Create collections with RLS:
5877
- \`boards\`: \`name\` (String, Required), \`ownerId\` (String, Required). Mode: \`private\`, ownerField: \`ownerId\`
@@ -66,7 +85,7 @@ cd urBackend/examples/sdk-kanban
6685
# Terminal 1: Start server
6786
cd server && npm install && npm start
6887
69-
# Terminal 2: Start client (from urBackend/examples/sdk-kanban)
88+
# Terminal 2: Start client (from sdk-kanban folder)
7089
cd client && npm install && npm run dev
7190
\`\`\`
7291
`

0 commit comments

Comments
 (0)