xref: /openbmc/webui-vue/docs/guide/readme.md (revision 7385e139)
1b115aea1SDerick Montague---
2b115aea1SDerick MontaguesidebarDepth: 0
3b115aea1SDerick Montague---
4b115aea1SDerick Montague
5b115aea1SDerick Montague# Getting Started
6b115aea1SDerick Montague
749287562SDerick MontagueThis guide outlines the architecture and technologies used to build the OpenBMC
849287562SDerick MontagueWeb UI. This guide exists to serve the following goals:
9b115aea1SDerick Montague
1049287562SDerick Montague1. Improve contributor efficiency while maintaining the quality and consistency
1149287562SDerick Montague   of the user interface
12b115aea1SDerick Montague1. Act as a collection of community agreed-upon standards
13b115aea1SDerick Montague
14b115aea1SDerick Montague## Coding Standards
15*7385e139SPatrick Williams
1649287562SDerick MontagueHaving an understanding of semantic HTML, CSS, and JavaScript is the critical
1749287562SDerick Montagueknowledge required to contribute to this project. The frameworks and libraries
1849287562SDerick Montagueused to build this UI include:
19*7385e139SPatrick Williams
20b115aea1SDerick Montague- [Vue](https://vuejs.org/)
21b115aea1SDerick Montague- [Vuex](https://vuex.vuejs.org/)
22b115aea1SDerick Montague- [Vue Router](https://router.vuejs.org/)
23b115aea1SDerick Montague- [Axios](https://github.com/axios/axios)
24b115aea1SDerick Montague- [Bootstrap-vue](https://bootstrap-vue.js.org/)
25b115aea1SDerick Montague- [Vuelidate](https://vuelidate.js.org/)
26b115aea1SDerick Montague- [Vue I18n](https://kazupon.github.io/vue-i18n/)
27b115aea1SDerick Montague
2849287562SDerick Montague::: tip Acquiring an understanding of these technologies will also be necessary.
29b115aea1SDerick Montague:::
30b115aea1SDerick Montague
3149287562SDerick MontagueYou will find more information about the standards and best practices in the
3249287562SDerick Montague[Coding Standards section of this guide](/guide/coding-standards/).
33b115aea1SDerick Montague
34b115aea1SDerick Montague## Guidelines
35*7385e139SPatrick Williams
3603dc2b7bSPaul FertserThe [guidelines section](/guide/guidelines/colors.md) contains the OpenBMC
3749287562SDerick Montaguecommunity agreed-upon decisions on color, motion, and typography within the
3849287562SDerick Montagueapplication. How to theme the application to meet company brand guidelines is
3903dc2b7bSPaul Fertserdocumented in [Customization](/customization/).
40b115aea1SDerick Montague
41b115aea1SDerick Montague## Components
42*7385e139SPatrick Williams
4349287562SDerick MontagueThe [components section](/guide/components/) is a guide to using both custom Vue
4449287562SDerick Montaguecomponents and components from the Bootstrap-Vue library.
45