Elentra JS Documentation
2.0
2.0
  • Introduction
  • Why Elentra JS 2.0?
    • Dedicated Repository
    • TypeScript
    • Class-Based Components
    • Vue Standard Routing
    • Organizational Theming
    • Yarn Package Manager
  • Developers
    • Getting Started
    • Setup Guide
      • Install Requirements
      • Clone the Repository
      • Environment Variables
      • Install Dependencies
      • Serve Dev Mode
  • Design System
    • Overview
    • Component Library
      • Directory Structure
      • Components
    • Style Library
      • Directory Structure
      • How it Works
        • Variables
        • Mixins
        • Utility Classes
        • Elements
        • Legacy Styles
        • Shim
    • Taxonomy
      • UI Taxonomy
      • UX Taxonomy
      • Variable & Utility Class Naming Convention
Powered by GitBook
On this page
  • 1. Compile and Serve EJS2
  • 2. Modify Elentra Developer .env
  • 3. Restart the Docker Container
  • 4. Confirm EJS2 is Up and Running
  1. Developers
  2. Setup Guide

Serve Dev Mode

PreviousInstall DependenciesNextOverview

Last updated 4 years ago

1. Compile and Serve EJS2

After all dependencies have been installed by running the yarn command, you will be able to serve the application in developer mode. To do this, simply run the following command in terminal, from the elentra-2x-js directory:

yarn serve

Some text will appear in the terminal as the serve process initializes, along with a percentage progress indicator. Once the process finishes you should see something similar to the following:

2. Modify Elentra Developer .env

Navigate to ~/Documents/elentra-developer and edit the .env file

DEV_MODE=true
FRONT_END_DOMAIN=http://elentra-1x-me.localhost:8081 # This should match the Local URL displayed by yarn serve (see above screenshot)

3. Restart the Docker Container

docker-compose down
docker-compose up -d --build

4. Confirm EJS2 is Up and Running

Any saved edits made within files located in the Elentra JS Design System (or any of the EJS modules) while the app is served in development mode will now cause an automatic recompilation of the files, enabling hot-reloading.

You can exit development mode by cancelling the actively running operation from terminal. On macOS, the shortcut for this in most shells is Ctrl-C.

You will need to run the yarn serve command from within ~/Sites/elentra-2x-js directory moving forward, anytime you need to:

  1. Run EJS2 Modules locally (Sandbox, Notices Management)

  2. Make changes to any EJS2 modules

  3. Create new EJS2 Modules

Compiling VueJS/Typescript code to plain JavaScript is a standard procedure in the development process.

Elentra JS is now being served in development mode. In ME 1.16 or higher, you can confirm by visiting . The updated Sandbox module allows you to perform CRUD operations for a series of Cards, all making use of Elentra JS 2.0.

http://elentra-1x-me.localhost/sandbox
Terminal Screen: Successful Compilation
Sandbox EJS2 Module.