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
2. 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
• Vuex
• Vue Router
• Axios
• Bootstrap-vue
• Vuelidate
• 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.

Guidelines

The guidelines section 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.

Components

The components section is a guide to using both custom Vue components and components from the Bootstrap-Vue library.