Challenge

Introduction2

This Nx monorepo includes the codebase of the Challenge ecosystem.

Apps2

• Challenge Registry
• Challenge Platform

Backend

• API Gateway
• Service Registry
• Keycloak (IAM)
• Databases: MariaDB, PostgreSQL, MongoDB
• User Service

Requirements

• Docker Engine version 18.06.0 or newer
• Visual Studio Code version 1.68.1 or newer (including Compose V2)

Usage

Opening the workspace in VS Code

Click on this badge to open the workspace in VS Code using our development container.

If you plan to contribute to this project, please create a fork and use its URL for cloning. For more information on contributing and/or our Forking Workflow approach, see CONTRIBUTING.md.

git clone --depth 1 --no-single-branch <repo url>

Then open your fork repo inside our devcontainer using these instructions:

• Developing inside a Container
• Develop on a remote host (optional)

Preparing the workspace

• Run challenge-install to install workspace tools like nx and jest.
• Run challenge-nx-cloud-help to start configuring Nx Cloud (optional).

Preparing the databases

• Run nx import-dev-data challenge-keycloak to seed Keycloak database.

Warning Keycloak must not be running when executing this command.

Starting the Challenge Registry

challenge-registry-serve

You can access the Challenge Registry on http://localhost:4200.

Documentation

Checkout the folder docs to learn more about this monorepo.

License

Apache License 2.0

Contributors

Main contributors and developers:

• Thomas Schaffter
• Verena Chung
• Rongrong Chai