Skip to content

enonic/app-contentstudio

Repository files navigation

Content Studio - Authoring interface for Enonic XP

Actions Status License Codacy Badge

Manage your content stored in Enonic XP. The documentation can be found here.

Free Core. Forever.

The foundational features of Content Studio — browsing, creating, and editing content, visual page editor, and basic publishing workflow — are always free to use for everyone. Build, launch, and host it for yourself or your clients without a subscription. The source code is publicly available right here on GitHub. Our Subscription and hosting plans give access to enterprise features such as AI, advanced governance, and commercial support.

[!NOTE] Content Studio provides extensions points for anyone to implement custom features under any license, without modifying and maintaining Content Studio itself.

Why the Enonic License?

As of Content Studio 6, this project is licensed under the Enonic License 2.0. The new license lets us ship previously separate applications — Content Studio+, AI features, and more — as a single app, simplifying maintenance for us and installation for you. Also eliminating any concerns related to the GPL license. It does not change how the core product works.

Usage

Just copy the built JAR files to the $XP_HOME/deploy folder, or use the deploy task from the Gradle:

./gradlew deploy

Building

Default

Run the following command to build the application with default options:

./gradlew build

With default build, the application will use the remote lib-admin-ui dependency and production environment.

Environment

To use the development environment (unminifed sources, source maps etc.), you must set its value explicitly with env parameter (only prod or dev supported):

./gradlew build -Penv=dev

If the environment is set, the Gradle will look for the local lib-admin-ui and xp repositories in the parent folder of your app-contentstudio repo. And if any present, will build them, along with building applications, instead of downloading the remote lib-admin-ui dependency. The environment parameter will also be passed to lib-admin-ui.

Both environments are almost identical, except that building in the development environment will result in creating the DTS files, sourcemaps and other things, critical for the debugging. The build itself may also be a bit slower sometimes.

Content Studio library

It's possible to build lib-contentstudio containing d.ts files for Typescript classes of the Content Studio application. This library can then be used to inherit from the Content Studio's Typescript classes in another application.

To build the library and deploy it to your local Maven repository:

./gradlew :lib-contentstudio:pTML -Plib

Quick

Sometimes, you may want to build your project faster. To do so, just skip the linting (lint task) and testing (test task):

./gradlew build -x lint -x test

In cases, when you set the environment type explicitly, skipping the lint or test will also result in skipping those two tasks in local lib-admin-ui build.

Clean

To rebuild the project from scratch, you may want to remove all compiles sources and dependencies.

./gradlew clean

About

Content Studio of Enonic XP

Resources

License

Contributing

Stars

10 stars

Watchers

3 watching

Forks

Packages

 
 
 

Contributors