Docs Developer Site

Get started with Enonic XP

Create, build and deploy your first app in minutes

Step 1 - Install Enonic CLI

Open Terminal app and run the following command:

brew tap enonic/cli
brew install enonic

Not yet familiar with the MacOS package manager Homebrew?
Get it from https://brew.sh

...or manually download the CLI executable for MacOS

Open Powershell and run the following command:

scoop bucket add enonic https://github.com/enonic/cli-scoop
scoop install enonic

Not yet familiar with Scoop, the command line installer for Windows?
Get it from https://scoop.sh/

...or manually download the CLI executable for Windows

Open your Shell and run the following command:

sudo snap install enonic

Not familiar with Snapcraft, Canonical's app store?
Get it from https://snapcraft.io/

...or manually download the CLI binary for Linux

STEP 2 - CREATE PROJECT

enonic project create

We recommend choosing "My first webapp" or "My first site" from the list of starters

STEP 3 - Build and deploy

Go to the newly created project folder, build and deploy the application:

cd myproject
enonic project deploy

NB! When started, the sandbox will be available at:
http://localhost:8080

Wrapping up...

You just installed our SDK, built and deployed your first project. Sweet!

To finish the setup, we recommend to complete the following tasks:

1. login

Create administrator user now, or do it later

Screenshot of the initial XP login - with ability to skip creation of user

2. Welcome TOUR

Install useful apps at the end of the tour

Image showing the last step of XP tour - Install apps

3. View Applications

Open "Applications" tool to see your apps

Screenshot of the main menu for Enonic XP

Hands on guides

To get the "real stuff" done, our practical guides is the way to go, a selection is listed below.
For more, visit the guides section.

My first webapp

Step-by-step tutorial to build your first webapp with Enonic XP

  • my first
  • webapp
  • html5
  • assets
  • javascript
  • controller

My first site

Step-by-step tutorial for building your first website with Enonic XP

  • my first
  • introduction
  • content types
  • demo content
  • pages

How to build a library

Learn how to build a library for reusing code and resources in Enonic XP

Reference documentation

Then, you might benefit from looking into the docs listed below:
For more insight and discovering hidden gems, visit the documentation section.

Enonic CLI

Manage XP project, SDK and instances from the command line

  • cli
  • xp management
  • xp projects
  • sdk
  • development kit

Enonic XP

In depth platform reference documentation

  • storage
  • runtime
  • xp apps
  • cms
  • api
  • release notes
  • hosting
  • development
  • admin

Content Studio

The ultimate CMS interface for Enonic XP

  • cms
  • editor
  • page editor
  • UI
  • rich text editor
  • content types
  • form

Enonic Market

Simply the best place to discover apps, libraries and starters for Enonic XP:

https://market.enonic.com

Community

Get help and share your knowledge through our various community channels

Forum

The best place to get an answer: https://discuss.enonic.com

Slack

Stay up2date and chat with other XPeers: https://slack.enonic.com

Github

We're all about open source, get inolved on https://github.com/enonic

 

professional support or services

Using Enonic in mission critical deployments?
We make a living from professional training, cloud hosting, software support and specialist consulting.

get in touch, or find out more:

https://enonic.com