Skip to content

Latest commit

 

History

History
106 lines (64 loc) · 4.97 KB

README.MD

File metadata and controls

106 lines (64 loc) · 4.97 KB
Raw

Important

Active development has moved to dotcms/core.

Publish to NPM DotCMS/core-web Tests

DotCMS Frontend

This repository contains the frontend infrastructure for the DotCMS admin system, includes the main app and all the internal libraries.

Content

Name Type Location Build with Description
dotcms-ui app apps/dotcms-ui Angular Main UI application
dotcms lib libs/dotcms Typescript JavaScript SDK for DotCMS API's
dot-layout-grid lib libs/dot-layout-grid Angular Components for layout editor
dot-rules lib libs/dot-rules Angular Components and services for rules
dotcms-field-elements lib libs/dotcms-field-elements Stenciljs Web components for form builder (deprecated)
dotcms-js lib libs/dotcms-js Angular Angular @injectables for DotCMS API
dotcms-models lib libs/dotcms-models Typescript DotCMS interfaces and types

NX Monorepo

This project was generated using Nx.

🔎 Nx is a set of Extensible Dev Tools for Monorepos.

Quick Start & Documentation

Nx Documentation

10-minute video showing all Nx features

Interactive Tutorial

Adding capabilities to your workspace

Nx supports many plugins which add capabilities for developing different types of applications and different tools.

These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well.

Below are our core plugins:

  • Angular
    • ng add @nrwl/angular
  • React
    • ng add @nrwl/react
  • Web (no framework frontends)
    • ng add @nrwl/web
  • Nest
    • ng add @nrwl/nest
  • Express
    • ng add @nrwl/express
  • Node
    • ng add @nrwl/node

There are also many community plugins you could add.

Generate an application

Run ng g @nrwl/angular:app my-app to generate an application.

You can use any of the plugins above to generate applications as well.

When using Nx, you can create multiple applications and libraries in the same workspace.

Generate a library

Run ng g @nrwl/angular:lib my-lib to generate a library.

You can also use any of the plugins above to generate libraries as well.

Libraries are shareable across libraries and applications. They can be imported from @dotcms/mylib.

Development server

Run ng serve my-app for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run ng g component my-component --project=my-app to generate a new component.

Build

Run ng build my-app to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run ng test my-app to execute the unit tests via Jest.

Run nx affected:test to execute the unit tests affected by a change.

Running end-to-end tests

Run ng e2e my-app to execute the end-to-end tests via Cypress.

Run nx affected:e2e to execute the end-to-end tests affected by a change.

Understand your workspace

Run nx dep-graph to see a diagram of the dependencies of your projects.

Further help

Visit the Nx Documentation to learn more.