Skip to content

Commit ef39a0a

Browse files
Updates readme
1 parent 4223cf6 commit ef39a0a

File tree

1 file changed

+20
-19
lines changed
  • samples/music-festival-vue-decoupled

1 file changed

+20
-19
lines changed

samples/music-festival-vue-decoupled/README.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,40 +9,41 @@ Content is fetched from Optimizely using the Content Delivery API: https://world
99
## Prerequisites
1010

1111
This project uses:
12-
* Node.js 18+
13-
* .NET SDK 6+
14-
* SQL Server 2016 Express LocalDB ([download here](https://www.microsoft.com/en-us/sql-server/sql-server-downloads))
12+
13+
- Node.js 18+
14+
- .NET SDK 9+
15+
- SQL Server 2016 Express LocalDB ([download here](https://www.microsoft.com/en-us/sql-server/sql-server-downloads))
1516

1617
## Setup and Run
1718

1819
1. Run `setup.cmd`. You can re-run `setup.cmd` at any time to reset the backend with a fresh database.
1920
2. Open terminal for `./backend` and run `dotnet run`.
20-
* Navigate to http://localhost:8081/.
21-
* Create an admin user. If the UI is not displayed automatically, navigate to http://localhost:8081/util/register.
22-
* Now you can access http://localhost:8081/episerver/cms.
21+
- Navigate to http://localhost:8081/.
22+
- Create an admin user. If the UI is not displayed automatically, navigate to http://localhost:8081/util/register.
23+
- Now you can access http://localhost:8081/episerver/cms.
2324
3. Since we reference two NPM modules locally, we need to install them first (this is not needed if you install the modules from npmjs.com).
24-
* Open terminal for `../../src/@episerver/content-definitions` and run `npm install` (only needed first run).
25-
* Open terminal for `../../src/@episerver/content-delivery` and run `npm install` (only needed first run).
25+
- Open terminal for `../../src/@episerver/content-definitions` and run `npm install` (only needed first run).
26+
- Open terminal for `../../src/@episerver/content-delivery` and run `npm install` (only needed first run).
2627
4. Open terminal for `./frontend` and run `npm install` (only needed first run).
27-
* Run `npm run serve`.
28-
* Navigate to http://localhost:8080/.
28+
- Run `npm run serve`.
29+
- Navigate to http://localhost:8080/.
2930

3031
## Notable files
3132

3233
### Vuex store modules
3334

34-
* [epiContext.js](frontend/src/store/modules/epiContext.js): makes `inEditMode` and `isEditable` flags available to the OPE helpers.
35-
* [epiDataModel.js](frontend/src/store/modules/epiDataModel.js): the module that stores and updates the model object to be displayed on every component.
35+
- [epiContext.js](frontend/src/store/modules/epiContext.js): makes `inEditMode` and `isEditable` flags available to the OPE helpers.
36+
- [epiDataModel.js](frontend/src/store/modules/epiDataModel.js): the module that stores and updates the model object to be displayed on every component.
3637

3738
### On-Page Editing helpers
3839

39-
* [epiBootstrap.js](frontend/src/epiBootstrap.js): registers the `contentSaved` and `epiReady` message handlers that updates the vuex store.
40-
* [epiEdit.js](frontend/src/directives/epiEdit.js): a directive that can be added on components to make them optionally editable (e.g. `<span v-epi-edit="Name">`), through `isEditable` and `epiDisableEditing`.
41-
* [EpiProperty.vue](frontend/src/components/EpiProperty.vue): a component that renders a button to edit a property (e.g. `<epi-property property-name="Name">`).
40+
- [epiBootstrap.js](frontend/src/epiBootstrap.js): registers the `contentSaved` and `epiReady` message handlers that updates the vuex store.
41+
- [epiEdit.js](frontend/src/directives/epiEdit.js): a directive that can be added on components to make them optionally editable (e.g. `<span v-epi-edit="Name">`), through `isEditable` and `epiDisableEditing`.
42+
- [EpiProperty.vue](frontend/src/components/EpiProperty.vue): a component that renders a button to edit a property (e.g. `<epi-property property-name="Name">`).
4243

4344
### Routing helpers
4445

45-
* [EpiPageComponentSelector.vue](frontend/src/components/EpiPageComponentSelector.vue): loads the Vue page component and owns its model.
46-
* [EpiBlockComponentSelector.vue](frontend/src/components/EpiBlockComponentSelector.vue): loads the Vue block component.
47-
* [EpiLink.vue](frontend/src/components/EpiLink.vue): regular links when in OPE and Vue router links otherwise.
48-
* [EpiViewModeLink.vue](frontend/src/components/EpiViewModeLink.vue): disables links completely when in OPE.
46+
- [EpiPageComponentSelector.vue](frontend/src/components/EpiPageComponentSelector.vue): loads the Vue page component and owns its model.
47+
- [EpiBlockComponentSelector.vue](frontend/src/components/EpiBlockComponentSelector.vue): loads the Vue block component.
48+
- [EpiLink.vue](frontend/src/components/EpiLink.vue): regular links when in OPE and Vue router links otherwise.
49+
- [EpiViewModeLink.vue](frontend/src/components/EpiViewModeLink.vue): disables links completely when in OPE.

0 commit comments

Comments
 (0)