Getting Started

This documentation is intended to help developers get started with Elentra JS on their workstation.

Prerequisites

Before proceeding, you must already have a fully functional developer workstation setup based on our Elentra Platform Developer Getting Started documentation. If that is not the case, please complete that step first.

Familiarize Yourself

Understand the Taxonomy

As a developer working within Elentra, it will be very beneficial to familiarize yourself with the Elentra JS taxonomy. The taxonomy provides a common language between developers and designers and will facilitate a strong understanding of common terminology.

Taxonomy

Learn the Variable & Utility Class Naming Convention

A consistent convention has been used for the naming of all of the variables and utility classes available to developers. Having a firm understanding of this naming convention will allow you to jump right in and start finding and using everything you need with the help of your IDE’s auto-complete.

Variable & Utility Class Naming Convention

Explore the Style & Component Library Directories

The component library included in Elentra JS is fairly comprehensive, and provides developers with the vast majority of common components that may be needed when contributing to existing modules or building new ones. Familiarizing yourself with the library components already available to you will help to provide an understanding of the best practices to keep in mind when building Vue.js components.

Whenever possible, try to make full use of the component library. Situations will always arise where custom components are necessary, however it is always preferable to use the library components as building blocks, to prevent redundant or duplicated code.

Directory Structure

Technical Setup Guide

After familiarizing yourself with the Component and Style libraries, you're ready to move on to the Technical Setup Guide section of the documentation, which will walk you through the steps required to start working with and eventually contributing to Elentra JS.

Setup Guide