@@ -4,23 +4,92 @@ This repository hosts a groceries demo application creatively called _Groceries
44
55## Getting Started
66
7- 1 . Bootstrap App
7+ 1 . In the root folder, bootstrap the app
88
99 ``` bash
1010 flutter pub get # Install deps
1111 flutter gen-l10n # Generate localization files
1212 ```
1313
14- 1 . Run Widgetbook
14+ 1 . In the ` widgetbook ` folder, run Widgetbook
1515
1616 ``` bash
1717 flutter pub get # Install deps
1818 dart run build_runner build -d # Generate files
1919 flutter run # Run
2020 ```
2121
22+ # Setup
23+
24+ Make sure to have completed the following setup before the workshop starts.
25+
26+ ## Flutter
27+
28+ Make sure you have Flutter 3.35 / Dart 3.9 installed.
29+
30+ ## Setup IDE
31+
32+ Setup Cursor, if you've already used the free trial, try another email.
33+
34+ Note: If you don't have access or don't want to use Cursor, you can use VS Code + Copilot + Claude Sonnet instead.
35+
36+ ## Setup Doc Indexes
37+
38+ 1 . In Cursor go to Settings > Cursor Settings > Indexing & Docs
39+ 1 . In the bottom add the following docs to index
40+ - ` https://docs.widgetbook.io `
41+ - ` https://pub.dev/documentation/widgetbook/latest/widgetbook/ `
42+
43+ Note: This might take some time.
44+
45+ ## Setup MCP servers
46+
47+ 1 . In Cursor go to Settings > Cursor Settings > MCP & Integrations
48+ 1 . Click the "New MCP Server" button at the bottom of the page to open Cursor's mcp.json file
49+ 1 . Insert the following code
50+
51+ ``` json
52+ {
53+ "mcpServers" : {
54+ "Widgetbook MCP" : {
55+ "type" : " http" ,
56+ "url" : " http://127.0.0.1:3013/mcp"
57+ },
58+ "Figma MCP" : {
59+ "type" : " http" ,
60+ "url" : " http://127.0.0.1:3845/mcp"
61+ },
62+ "dart" : {
63+ "command" : " dart" ,
64+ "args" : [
65+ " mcp-server"
66+ ]
67+ }
68+ }
69+ }
70+ ```
71+
72+ Note: MCP servers for VS Code are pre-defined in ` .vscode/mcp.json ` .
73+
74+ ## Rules
75+
76+ We created pre-defined cursor rules (` .cursor/rules ` ) for the workshop.
77+ These rules are not automatically applied.
78+ You can check them out in advance.
79+
80+ Note: If you're using VS Code you can find the rules in ` .github/prompts ` .
81+
82+ ## Setup Figma Deskop
83+
84+ 1 . Make sure you have the lastest version of the Figma Desktop App installed.
85+ 1 . If you don't have a Figma account with an Professional, Organization, or Enterprise plan, log into the following Figma account:
86+ - Email: contact+figma@widgetbook.io
87+ - Password: ` WidgetbookWorkshop `
88+ - Notes: Account will be deactivated after the workshop
89+ 1 . If you have one of the mentioned paid plans, open the Figma file
90+
2291## Resources
2392
2493- [ 🔗 Figma File] ( https://www.figma.com/design/HsANkdhbsCNTkXBzNJRNLD/Groceries-Demo?node-id=7225-2991&t=4oLAnrUYEax8YzGo-1 )
2594- [ 🔗 Widgetbook Docs] ( https://docs.widgetbook.io/ )
26- - [ 🔗 Widgetbook Cloud] ( https://app.widgetbook.io )
95+ - [ 🔗 Widgetbook Cloud] ( https://app.widgetbook.io/ )
0 commit comments