Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rewriting README.md to make it more technical and concise #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Rewriting README.md to make it more technical and concise #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
## Running locally

This project uses the Maven Cargo plugin to run Essentials, the CMS and site locally in Tomcat.
This project uses the Maven Cargo plugin to run Essentials, the CMS, and site locally in Tomcat.
From the project root folder, execute:

mvn clean verify
mvn -P cargo.run

By default this includes and bootstraps repository data from the repository-data/development module,
which is deployed by cargo to the Tomcat shared/lib.
If you want or need to start *without* bootstrapping the development data, for example when testing
against an existing repository, you can specify the *additional* Maven profile without-development-data to do so:
To start *without* bootstrapping the development data like testing against an existing repository, you can specify the *additional* Maven profile without-development-data like below:

mvn -P cargo.run,without-development-data

Expand All @@ -23,8 +22,8 @@ Logs are located in target/tomcat8x/logs
Best Practice for development
=============================

Use the option -Drepo.path=/some/path/to/repository during start up. This will avoid
your repository to be cleared when you do a mvn clean.
Use the option -Drepo.path=/some/path/to/repository during start up. This will prevent
your repository from being cleared when you do a mvn clean.

For example start your project with:

Expand Down