blob: 19c481c2988467ebe58c9a8bb899f131614e0596 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
|
---
sidebarDepth: 0
---
# Getting Started
This guide outlines the architecture and technologies used to build the OpenBMC
Web UI. This guide exists to serve the following goals:
1. Improve contributor efficiency while maintaining the quality and consistency
of the user interface
1. Act as a collection of community agreed-upon standards
## Coding Standards
Having 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:
- [Vue](https://vuejs.org/)
- [Vuex](https://vuex.vuejs.org/)
- [Vue Router](https://router.vuejs.org/)
- [Axios](https://github.com/axios/axios)
- [Bootstrap-vue](https://bootstrap-vue.js.org/)
- [Vuelidate](https://vuelidate.js.org/)
- [Vue I18n](https://kazupon.github.io/vue-i18n/)
::: tip Acquiring an understanding of these technologies will also be necessary.
:::
You will find more information about the standards and best practices in the
[Coding Standards section of this guide](/guide/coding-standards/).
## Guidelines
The [guidelines section](/guide/guidelines/colors.md) 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 [Customization](/customization/).
## Components
The [components section](/guide/components/) is a guide to using both custom Vue
components and components from the Bootstrap-Vue library.
|
