Welcome! We recommend that you have a read of our guide on how to build widgets at https://docs.nosto.com/ugc.
It will guide you set by step on how to build your first widget.
Once you have read our guide, you can begin setting up your IDE for widget template development. To get started, follow the instructions below
-
Clone your Forked repo of stackla/stackla-widget-templates. You can do this by executing
git clone https://your-github-repo-here
-
Utilise a code editor such as VSCode to prepare your IDE for development
-
Inside the folder, fetch the latest widget-utils repository submodule.
NOTE: If you would like to use your own widget utilities fork, you can also update the .gitmodules file and place the URL to your git repository there.
Execute the following;
git submodule init && git submodule update
- Install all packages by executing:
npm install
- Execute
npm run start
to see our gallery of widgets in action. - Access the following URL, substituting the widgetType with any widget you wish to preview.
http://localhost:4003/preview?widgetType=carousel
Congratulations! You are now ready to start developing your first widget.
Lets get started.