Skip to content

Commit 4b7077c

Browse files
committed
Include a readme to show how to get started with the example projects
1 parent 2051262 commit 4b7077c

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

examples/README.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Getting started with the examples
2+
3+
To get started, open the `UI Examples.sln` file in the root and run one of the websites within the `Examples` folder.
4+
5+
The project will boot into an empty Umbraco site. Navigate to the backoffice and user the credentials in the `appsettings.json` to login.
6+
7+
You will see a new section for `UI Examples` which contains the work from the `Our.Umbraco.UiExamples.v13` and `Our.Umbraco.UiExamples.v15` in their respective sites.
8+
9+
## Making changes
10+
11+
Both projects will automatically compile and bring the assets into the example sites when building.
12+
13+
**Quicker dev in v15** can be acheived by opening the `Our.Umbraco.UiExamples.v15` in the command line/terminal and running the `npm run dev` command (make sure to either build or run `npm ci` first to install node dependencies).

0 commit comments

Comments
 (0)