Prepare monorepo to host challenge platform app

[tschaffter]

Goal

Demonstrate that the development of the challenge platform perfectly fits inside this monorepo.

Motivations

Adding the challenge platform app to this monorepo brings the following benefit to the new app:

• Reuse the same code structure as the challenge registry.
• Share UI components available in libs/shared across multiple apps (challenge registry, challenge platform, tool registry).
• Reuse some of the microservices developed in the context of the challenge registry
  • The REST API of the challenge registry is transitioning from a monolithic to micro-services implementations.
  • Microservices can be reused across multiple apps in order to minimize development and maintenance overhead.
• This monorepo welcome developers who use different programming languages and frameworks.
  • Existing REST APIs are implemented in Python and Java (Spring Boot).
• Centralize the identity and access management for multiple apps (challenge registry, challenge platform, tool registry).
  • Keycloak, an IAM solution, has already been integrated to this monorepo.

Illustration reproduced from this Nx article.

Preparing the monorepo

• Rename workspace (npm) scope
  • challenge-registry > challenges OR challenge or sagebionetworks
• Rename apps and libraries
  • apps/web-app > apps/registry OR apps/challenge-registry
  • apps/api > apps/registry-api OR apps/challenge-registry-api
  • libs/web > libs/registry OR libs/challenge-registry
• Add app and library scope for the challenge platform
  • apps/platform OR apps/challenge-platform
  • libs/platform OR libs/challenge-platform

Create initial challenge platform app

The goals are to demonstrate 1) how UI components can be shared by multiple apps and 2) demonstrate that a user with a single account stored in Keycloak can login to the challenge registry and the challenge platform.

• Use the navbar and footer developed for the challenge registry.
• Pages
  • Home page
  • User profile page

Estimated effort

• 2 days to prepare the monorepo and create the challenge platform apps and libraries.
• 2-3 days to enable the user to login to the challenge registry and challenge platform using the same account.

Tasks

• [x] https://github.com/Sage-Bionetworks/challenge-registry/issues/227
• [ ] #233
• [x] https://github.com/Sage-Bionetworks/challenge-registry/issues/229

[tschaffter]

References

• Taming Code Organization with Module Boundaries in Nx