1
|
(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{423:function(t,e,n){"use strict";n.r(e);var o=n(41),r=Object(o.a)({},(function(){var t=this,e=t.$createElement,n=t._self._c||e;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"getting-started"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#getting-started"}},[t._v("#")]),t._v(" Getting Started")]),t._v(" "),n("p",[t._v("This guide outlines the architecture and technologies used to build the OpenBMC\nWeb UI. This guide exists to serve the following goals:")]),t._v(" "),n("ol",[n("li",[t._v("Improve contributor efficiency while maintaining the quality and consistency\nof the user interface")]),t._v(" "),n("li",[t._v("Act as a collection of community agreed-upon standards")])]),t._v(" "),n("h2",{attrs:{id:"coding-standards"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#coding-standards"}},[t._v("#")]),t._v(" Coding Standards")]),t._v(" "),n("p",[t._v("Having an understanding of semantic HTML, CSS, and JavaScript is the critical\nknowledge required to contribute to this project. The frameworks and libraries\nused to build this UI include:")]),t._v(" "),n("ul",[n("li",[n("a",{attrs:{href:"https://vuejs.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Vue"),n("OutboundLink")],1)]),t._v(" "),n("li",[n("a",{attrs:{href:"https://vuex.vuejs.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Vuex"),n("OutboundLink")],1)]),t._v(" "),n("li",[n("a",{attrs:{href:"https://router.vuejs.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Vue Router"),n("OutboundLink")],1)]),t._v(" "),n("li",[n("a",{attrs:{href:"https://github.com/axios/axios",target:"_blank",rel:"noopener noreferrer"}},[t._v("Axios"),n("OutboundLink")],1)]),t._v(" "),n("li",[n("a",{attrs:{href:"https://bootstrap-vue.js.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Bootstrap-vue"),n("OutboundLink")],1)]),t._v(" "),n("li",[n("a",{attrs:{href:"https://vuelidate.js.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Vuelidate"),n("OutboundLink")],1)]),t._v(" "),n("li",[n("a",{attrs:{href:"https://kazupon.github.io/vue-i18n/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Vue I18n"),n("OutboundLink")],1)])]),t._v(" "),n("div",{staticClass:"custom-block tip"},[n("p",{staticClass:"custom-block-title"},[t._v("Acquiring an understanding of these technologies will also be necessary.")])]),t._v(" "),n("p",[t._v("You will find more information about the standards and best practices in the\n"),n("RouterLink",{attrs:{to:"/guide/coding-standards/"}},[t._v("Coding Standards section of this guide")]),t._v(".")],1),t._v(" "),n("h2",{attrs:{id:"guidelines"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#guidelines"}},[t._v("#")]),t._v(" Guidelines")]),t._v(" "),n("p",[t._v("The "),n("RouterLink",{attrs:{to:"/guide/guidelines/colors.html"}},[t._v("guidelines section")]),t._v(" contains the OpenBMC\ncommunity agreed-upon decisions on color, motion, and typography within the\napplication. How to theme the application to meet company brand guidelines is\ndocumented in "),n("RouterLink",{attrs:{to:"/customization/"}},[t._v("Customization")]),t._v(".")],1),t._v(" "),n("h2",{attrs:{id:"components"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#components"}},[t._v("#")]),t._v(" Components")]),t._v(" "),n("p",[t._v("The "),n("RouterLink",{attrs:{to:"/guide/components/"}},[t._v("components section")]),t._v(" is a guide to using both custom Vue\ncomponents and components from the Bootstrap-Vue library.")],1)])}),[],!1,null,null,null);e.default=r.exports}}]);
|
