Skip to content

Commit 0841592

Browse files
fix: update Kanban template instructions with env setup and schema details
- Add environment variable configuration steps (server/.env and client/.env) - Document complete collection schemas with RLS settings - Add note about Vite requiring server restart for env changes - Clarify client startup runs from urBackend/examples/sdk-kanban
1 parent 2920179 commit 0841592

1 file changed

Lines changed: 15 additions & 8 deletions

File tree

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

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,17 +51,24 @@ A Kanban board app using \`@urbackend/sdk\` for data and auth.
5151
\`\`\`bash
5252
git clone https://github.com/geturbackend/urBackend.git
5353
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
6054
\`\`\`
6155
6256
1. Enable Auth in your urBackend project
63-
2. Create \`boards\` and \`tasks\` collections with RLS
64-
3. Copy \`VITE_URBACKEND_PK\` from your API keys
57+
2. Create collections with RLS:
58+
- \`boards\`: \`name\` (String, Required), \`ownerId\` (String, Required). Mode: \`private\`, ownerField: \`ownerId\`
59+
- \`tasks\`: \`title\` (String, Required), \`description\` (String), \`status\` (String, Default: \`Todo\`), \`boardId\` (String, Required), \`ownerId\` (String, Required). Mode: \`private\`, ownerField: \`ownerId\`
60+
3. Configure environment variables:
61+
- Copy \`server/.env.example\` to \`server/.env\` and set \`URBACKEND_SECRET_KEY=sk_live_...\`
62+
- Copy \`client/.env.example\` to \`client/.env\` and set \`VITE_URBACKEND_PK=pk_live_...\`
63+
- Note: Vite-loaded environment changes require restarting the client server
64+
4. Run the application:
65+
\`\`\`bash
66+
# Terminal 1: Start server
67+
cd server && npm install && npm start
68+
69+
# Terminal 2: Start client (from urBackend/examples/sdk-kanban)
70+
cd client && npm install && npm run dev
71+
\`\`\`
6572
`
6673
},
6774
{

0 commit comments

Comments
 (0)