Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 14-Dec-2022 | - | ||||
coding-standards/ | H | 14-Dec-2022 | - | 113 | 84 | |
components/ | H | 14-Dec-2022 | - | 983 | 834 | |
guidelines/ | H | 19-Apr-2024 | - | 185 | 135 | |
quickstart/ | H | 14-Dec-2022 | - | 321 | 269 | |
unit-testing/ | H | 14-Dec-2022 | - | 191 | 136 | |
readme.md | H A D | 14-Dec-2022 | 1.5 KiB | 45 | 32 |
readme.md
1--- 2sidebarDepth: 0 3--- 4 5# Getting Started 6 7This guide outlines the architecture and technologies used to build the OpenBMC 8Web UI. This guide exists to serve the following goals: 9 101. Improve contributor efficiency while maintaining the quality and consistency 11 of the user interface 121. Act as a collection of community agreed-upon standards 13 14## Coding Standards 15 16Having an understanding of semantic HTML, CSS, and JavaScript is the critical 17knowledge required to contribute to this project. The frameworks and libraries 18used to build this UI include: 19 20- [Vue](https://vuejs.org/) 21- [Vuex](https://vuex.vuejs.org/) 22- [Vue Router](https://router.vuejs.org/) 23- [Axios](https://github.com/axios/axios) 24- [Bootstrap-vue](https://bootstrap-vue.js.org/) 25- [Vuelidate](https://vuelidate.js.org/) 26- [Vue I18n](https://kazupon.github.io/vue-i18n/) 27 28::: tip Acquiring an understanding of these technologies will also be necessary. 29::: 30 31You will find more information about the standards and best practices in the 32[Coding Standards section of this guide](/guide/coding-standards/). 33 34## Guidelines 35 36The [guidelines section](/guide/guidelines/colors.md) contains the OpenBMC 37community agreed-upon decisions on color, motion, and typography within the 38application. How to theme the application to meet company brand guidelines is 39documented in [Customization](/customization/). 40 41## Components 42 43The [components section](/guide/components/) is a guide to using both custom Vue 44components and components from the Bootstrap-Vue library. 45