Quick Start Guide

❯ Set up your Development Environment

• Frontend Build Management
• Backend Build Management

❯ Clone the project

Change the current working directory to the location where you want the cloned project to be:

cd ~/workspace

Clone the project by running the following command:

git clone git@github.com:Robinyo/serendipity.git

❯ Enable TLS

Local Development

Follow the steps in the project's Developer Documentation to use mkcert to create and install a local certificate authority and to generate the certificates required to enable TLS.

❯ Development

To build the frontend:

# In the project's /frontend directory

ng build --configuration="development" serendipity-auth-lib && \
ng build --configuration="development" serendipity-utils-lib && \
ng build --configuration="development" serendipity-components-lib && \
ng build --configuration="development" serendipity-dynamic-forms-lib && \
ng build --configuration="development" serendipity-flowable-lib && \
ng build --configuration="development" serendipity-party-lib && \
ng build --configuration="development" serendipity-work-lib && \
ng build --configuration="development" serendipity-pwa

To build the backend services:

# In the project's /backend directory

mvn clean install spring-boot:repackage

Docker Compose

To build the project:

docker compose build

With a single command, you can create and start all the services:

docker compose up

The containers may take a minute or two to startup.

Note: Docker Compose will look for an .env file in the current working directory.

Navigate to:

https://serendipity.localhost

To stop the services:

docker compose stop

To remove the services:

docker compose down

To remove the data volumes:

docker volume rm backend_postgres_data && \
docker volume rm backend_openldap_data