@dotcms/client 0.0.1-alpha.33 → 0.0.1-alpha.34
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# DotCMS Frontend
|
|
2
|
+
|
|
3
|
+
This folder contains the frontend infrastructure for the DotCMS admin system, includes the main app and all the internal libraries.
|
|
4
|
+
|
|
5
|
+
## Content
|
|
6
|
+
|
|
7
|
+
| Name | Type | Location | Build with | Description |
|
|
8
|
+
| -------------------------------------------------------------------------------------------------- | ---- | ---------------------------- | ---------- | ----------------------------------------------------------- |
|
|
9
|
+
| [dotcms-ui](https://github.com/dotCMS/core-web/tree/master/apps/dotcms-ui) | app | `apps/dotcms-ui` | Angular | Main UI application |
|
|
10
|
+
| [dotcdn](https://github.com/dotCMS/core-web/tree/master/apps/dotcdn) | app | `apps/dotcdn` | Angular | App for the dotCDN plugin |
|
|
11
|
+
| [dotcms-block-editor](https://github.com/dotCMS/core-web/tree/master/apps/dotcms-block-editor) | app | `apps/dotcms-block-editor` | Angular | App to build de block-editor as a Web Component |
|
|
12
|
+
| [dotcms](https://github.com/dotCMS/core-web/tree/master/libs/dotcms) | lib | `libs/dotcms` | Typescript | JavaScript SDK for DotCMS API's |
|
|
13
|
+
| [dot-layout-grid](https://github.com/dotCMS/core-web/tree/master/libs/dot-layout-grid) | lib | `libs/dot-layout-grid` | Angular | Components for layout editor |
|
|
14
|
+
| [block-editor](https://github.com/dotCMS/core-web/tree/master/libs/block-editor) | lib | `libs/block-editor` | TitTap | Block editor components |
|
|
15
|
+
| [dot-rules](https://github.com/dotCMS/core-web/tree/master/libs/dot-rules) | lib | `libs/dot-rules` | Angular | Components and services for rules |
|
|
16
|
+
| [dotcms-field-elements](https://github.com/dotCMS/core-web/tree/master/libs/dotcms-field-elements) | lib | `libs/dotcms-field-elements` | Stenciljs | Web components for form builder (deprecated) |
|
|
17
|
+
| [dotcms-js](https://github.com/dotCMS/core-web/tree/master/libs/dotcms-js) | lib | `libs/dotcms-js` | Angular | Angular @injectables for DotCMS API |
|
|
18
|
+
| [dotcms-models](https://github.com/dotCMS/core-web/tree/master/libs/dotcms-models) | lib | `libs/dotcms-models` | Typescript | DotCMS interfaces and types |
|
|
19
|
+
| [dotcms-scss](https://github.com/dotCMS/core-web/tree/master/libs/dotcms-scss) | lib | `libs/dotcms-scss` | SCSS | SCSS shared files for theme Angular PrimeNG and Dijit Theme |
|
|
20
|
+
|
|
21
|
+
## dotCMS core-web Monorepo
|
|
22
|
+
|
|
23
|
+
This monorepo, powered by [Nx](https://nx.dev), contains everything related to the frontend development for dotCMS.
|
|
24
|
+
|
|
25
|
+
### Installing Dependencies
|
|
26
|
+
|
|
27
|
+
Run `yarn install` to install all project dependencies.
|
|
28
|
+
|
|
29
|
+
### Development Server
|
|
30
|
+
|
|
31
|
+
To start the development server, run `nx serve dotcms-ui`. Visit [http://localhost:4200/](http://localhost:4200/). The app will automatically reload if you make any changes to the source files. We have set up a proxy to the backend server (on port 8080), allowing you to run both the backend server (by building the master branch or using Docker) and the frontend server simultaneously.
|
|
32
|
+
|
|
33
|
+
### Building the Project
|
|
34
|
+
|
|
35
|
+
We have three main applications to build:
|
|
36
|
+
- **dotcms-ui**: Run `nx build dotcms-ui`.
|
|
37
|
+
- **dotcms-block-editor**: Run `nx build dotcms-block-editor`.
|
|
38
|
+
- **dotcms-binary-field-builder**: Run `nx build dotcms-binary-field-builder`.
|
|
39
|
+
|
|
40
|
+
### Running Unit Tests
|
|
41
|
+
|
|
42
|
+
To run all unit tests for projects currently testable, use `yarn run test:dotcms`. To test a specific app or library, run `nx test {name-of-the-app-or-lib}`.
|
|
43
|
+
|
|
44
|
+
Use `nx affected:test` to execute the unit tests affected by recent changes.
|
|
45
|
+
|
|
46
|
+
### Understanding Your Workspace
|
|
47
|
+
|
|
48
|
+
Run `nx dep-graph` to see a diagram of your projects' dependencies. This will help you better understand the structure and relationships in your monorepo.
|