README.md

DreamFactory Admin Interface

Admin interface for managing DreamFactory instance.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
  • Development
  • Linting and Formatting
    • Lint
    • Lint and Fix
    • Format
• Running the tests
  • Run Unit Tests
  • Run and Watch Unit Tests
  • Run Unit Tests with Coverage
• Building the Project
• Adding additional languages

Getting Started

Prerequisites

• Node.js >=16.14.0
• Angular CLI

Installation

npm install

Install husky

husky is used to run git hooks for formatting and linting checking code prior to commiting code. To install husky run the following command:

npm run prepare

Usage

Development

npm start

Proxying to DreamFactory instance is configured in proxy.conf.json.

Linting and Formatting

Lint

npm run lint

Lint and Fix

npm run lint:fix

Format

npm run prettier

Running the tests

jest is used for unit testing. Tests are named with the following convention: [name].spec.ts

Run Unit Tests

npm run test

Run and Watch Unit Tests

npm run test:watch

Run Unit Tests with Coverage

npm run test:coverage

Building the Project

npm run build

Adding additional languages

When more than one language is supported, the language selector will be displayed in the top right corner of the application.

• User language will be detected from preference provided by browser. If browser preference is a supported language it will be selected by default.

• If language selector is enabled and user change language manually, their preference is stored in localStorage for future reference. If language preference is found in localStorage, than it is treated as default language.

• To add a new language, follow these steps:

  1. Add a new entry to the SUPPORTED_LANGUAGES array in src/app/shared/constants/languages.ts.
     • code: The language code. This is used to identify the language in the application.
     • altCode: Alternative language code that might be provided by browser. eg en-US, en-CA.
  2. Create new translation files in src/assets/i18n and every sub-folder.
     • Ensure label for languages are created in alternative language in src/assets/i18n/en.json

       "languages": {
         "en": "English"
       }

     • These are used to display language label in dropdown.