Skip to content

developer-environment.md

Latest commit

 

History

History
53 lines (42 loc) · 3.25 KB

developer-environment.md

File metadata and controls

53 lines (42 loc) · 3.25 KB
Raw
id developer-environment
title Developer's Local Environment
description Options for locally developing CMS Platform

CMS Platform is meant to be fully developed offline. This allows developers to code, build, test, and run with the least friction when developing.

Developers can use VS Code with several included recommended extensions for a truly Open Source environment.

Developing with Tomcat

The following steps will guide you through the developer tools and environment setup so that your code changes can be compiled and copied automatically and then seen in your web browser.

  1. Install OpenJDK 21+
  2. Install Apache Ant 1.10+ and configure your terminal's path with ANT_HOME/bin
  3. Install Apache Tomcat 9.x into a directory of your choice
  4. Install the PostgreSQL database server – natively on MacOS with Postgres.app or with a Docker container like (postgis/postgis:18-3.6-alpine)
  5. Clone the CMS Platform repo – git clone https://github.com/rajkowski/cms-platform.git
  6. In the repo directory execute ant deploy – this updates code and library changes in a working Tomcat exploded webapp directory ./out/exploded/webapps/ROOT
  7. Copy Tomcat's conf to ./out/exploded/conf – this is where Tomcat will look for configuration information
  8. Set environment variables for CATALINA_BASE to the source code's working exploded directory, CMS_PATH to a new folder for the CMS user attachments, and DB_NAME for the PostgreSQL database; see example below...
  9. Start Tomcat and the web application using Tomcat's run command: bin/catalina.sh run

Minimal Environment Variables:

CATALINA_BASE=/path/to/cms-platform/out/exploded
CMS_PATH=/path/to/files/cms-platform
DB_NAME=cms-platform
CMS_ADMIN_USERNAME=user@example.com
CMS_ADMIN_PASSWORD=test

If not specified, the path for file assets and external configuration on Linux is /opt/cms-platform; otherwise $USER_HOME/Web/cms-platform

Use ant deploy to further update the web application with your changes. In debug mode, many Javascript, JSP, and XML files are automatically reloaded. If there are newly compiled Java files, libraries, or database migration scripts, then restart Tomcat.

Developer Resources