xref: /openbmc/webui-vue/docs/guide/readme.md (revision 842b5dbe)
1---
2sidebarDepth: 0
3---
4
5# Getting Started
6
7This guide outlines the architecture and technologies used to build the OpenBMC Web UI. This guide exists to serve the following goals:
8
91. Improve contributor efficiency while maintaining the quality and consistency of the user interface
101. Act as a collection of community agreed-upon standards
11
12## Coding Standards
13Having an understanding of semantic HTML, CSS, and JavaScript is the critical knowledge required to contribute to this project. The frameworks and libraries used to build this UI include:
14- [Vue](https://vuejs.org/)
15- [Vuex](https://vuex.vuejs.org/)
16- [Vue Router](https://router.vuejs.org/)
17- [Axios](https://github.com/axios/axios)
18- [Bootstrap-vue](https://bootstrap-vue.js.org/)
19- [Vuelidate](https://vuelidate.js.org/)
20- [Vue I18n](https://kazupon.github.io/vue-i18n/)
21
22::: tip
23Acquiring an understanding of these technologies will also be necessary.
24:::
25
26You will find more information about the standards and best practices in the [Coding Standards section of this guide](/guide/coding-standards/).
27
28## Guidelines
29The [guidelines section](/guide/guidelines/colors) contains the OpenBMC community agreed-upon decisions on color, motion, and typography within the application. How to theme the application to meet company brand guidelines is documented in [Themes](/themes).
30
31## Components
32The [components section](/guide/components/) is a guide to using both custom Vue components and components from the Bootstrap-Vue library.
33
34