Skip to content

Commit

Permalink
feat: minor adjustments to readme and added missing required configur…
Browse files Browse the repository at this point in the history
…ation to appsettings.json
  • Loading branch information
brianhdk committed Aug 17, 2022
1 parent 718cf76 commit 300a9a7
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ There is a sample site for both Umbraco 9 and Umbraco 10. The demo sites uses th
1. Start by cloning the repository.
2. Setting up our frontend.

1. Navigate to 'samples/UmbracoV9/client'
1. Navigate to `samples/UmbracoV9/client` (also if intend to run the v10 sample - see above)
2. Run `npm install` via a command prompt
3. Run `npm run serve` via a command prompt

3. Spinning up the site.

1. Navigate to 'samples/UmbracoV9' or 'samples/UmbracoV10', depending on whether you want to sample v9 or v10.
2. In the appsettings, enter your Dataset Id and API-key for Relewise (you can find those at https://my.relewise.com under Settings -> Developer Settings). There is a commented out section, where you can enter it (Remember to comment the section back in!)
1. Navigate to `samples/UmbracoV9` or `samples/UmbracoV10`, depending on whether you want to sample v9 or v10.
2. In the appsettings, enter your `DatasetId` and `ApiKey` for Relewise (you can find those at https://my.relewise.com under `Settings -> Developer Settings`). There is a commented out section, where you can enter it (Remember to comment the section back in!). Alternatively you can create a `local.settings.json` file and add the section in there.
3. Run `dotnet run` via a command prompt.
4. Umbraco will throw some error in the console - just ignore those
5. `dotnet run` open a new browser tab, continue the setup in that new tab.
Expand Down
14 changes: 11 additions & 3 deletions samples/UmbracoV10/appsettings.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,18 @@
"Id": "7841fd23-322f-44f7-b295-a857b6f2fc45"
}
}
}
},
//"Relewise": {
// "DatasetId": "<your dataset id here>",
// "ApiKey": "<your api key here>",
// "Timeout": "00:00:05"
// "ApiKey": "<your master api key here>",
// "Timeout": "00:00:05",
// "Named": {
// "Browser": {
// "Tracker": {
// "ApiKey": "<your browser api key here>",
// "Timeout": "00:00:03"
// }
// }
// }
//}
}
6 changes: 6 additions & 0 deletions samples/UmbracoV9/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 300a9a7

Please sign in to comment.