Skip to content

valdisiljuconoks/musicfestival-vue-template

 
 

Repository files navigation

MusicFestival Vue.js Templates

This sample site demonstrates one approach to render Episerver content in a client side framework that is using client side routing for navigation with a working On Page Edit (OPE) mode in the Episerver UI.

This particular solution uses Vue.js but most of the techniques are framework agnostic and can be used with any other framework, such as React or Angular.

Content is fetched from Episerver using the Content Delivery API: https://world.episerver.com/documentation/developer-guides/CMS/Content/content-delivery-api/

Prerequisites

This project uses:

  • npm 6+
  • Visual Studio 2015+
  • SQL Server 2016 Express LocalDB (download here)

Setup and Run

  1. Run setup.cmd
  2. Open MusicFestival.Vue.Template.sln
  3. Hit Ctrl + F5
  4. Login with either one of the following:
Name Password Mailbox Email
cmsadmin sparr0wHawk
emil sparr0wHawk https://www.mailinator.com/v3/index.jsp?zone=public&query=epic-emil epic-emil@mailinator.com
ida sparr0wHawk https://www.mailinator.com/v3/index.jsp?zone=public&query=epic-ida epic-ida@mailinator.com
alfred sparr0wHawk https://www.mailinator.com/v3/index.jsp?zone=public&query=epic-alfred epic-alfred@mailinator.com
lina sparr0wHawk https://www.mailinator.com/v3/index.jsp?zone=public&query=epic-lina epic-lina@mailinator.com

Notable files

On-Page Editing helpers

  • epiEdit.js: a directive that can be added on components to make them editable (e.g. <span v-epi-edit="Name">).
  • EpiProperty.vue: a component that renders a button to edit a property (e.g. <epi-property property-name="Name">).
  • epiDataModelMixin.js: adds a model property to any component and keeps it updated when content is updated.
  • epiContext.js: makes inEditMode and isEditable flags available to the OPE helpers.

Routing helpers

API

Overall structure

To avoid having multiple razor files the pages and blocks have their own controller and only one razor view each.

DefaultPageController.cs
    DefaultPage/Index.cshtml
        Site.vue
            router-view (Vue.js)
                router.js
                    PageComponentSelector.vue (owns the model)
                        ArtistContainerPage/ArtistDetailsPage/LandingPage.vue
 
PreviewController.cs
    Preview/Index.cshtml (sets content-link attribute on <preview>)
        Preview.vue (owns the model, and renders multiple BlockComponentSelector)
            BlockComponentSelector.vue
                BuyTicketBlock/ContentBlock/GenericBlock.vue

Building client side resources

  • npm run webpack: Alias for npm run webpack-build-dev.
  • npm run webpack-build-dev: Builds a development package.
  • npm run webpack-watcher: Builds a development package, and re-builds automatically when relevant files are changed.
  • npm run webpack-build-prod: Builds a production package.

About

The Vue.js version of the MusicFestival template site

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 87.1%
  • C# 6.4%
  • Vue 3.7%
  • JavaScript 2.3%
  • Classic ASP 0.3%
  • HTML 0.1%
  • Batchfile 0.1%