Skip to content

[Story] Improve developer experience #996

@ReneSchroederLJ

Description

@ReneSchroederLJ

As a PURIS contributor ,
I want a better development experience ,
so that the barrier of entry for new contributors is lower .

Hints / Details

In its current state, the PURIS FOSS application lacks a lot of quality of life features to make contributing to it as easy as possible. This is especially true for the debug process of both frontend and backend.

To improve this, the following points should be addressed:

  • extension of generate-keys.sh to generate the following new environment file:
    • .env file for bruno (see details here)
  • update local.bru to use the newly generated .env file
  • add .env.customer and .env.supplier in /frontend to automatically enable running the frontends without a container
  • keycloak realm adjustments to enable the aforementioned local frontend execution
  • improvements to the Dockerfile for frontend and backend to improve performance
  • addition of environment variables to enable debugging of backend containers
  • update the deploy.sh script to enable automatically rebuilding the container images for backend and frontend
    • this behaviour should be configurable by a new flag (e.g. -p), which preserves the existing images

All changes should be reflected by updates to the documentation in local/INSTALL.md and docs/DEVELOPMENT.md.

Additionally, the docs/DEVELOPMENT.md documentation should be improved by describing the development process in more detail. This includes, but is not limited to, the following additional information:

  • reminder to always update changelogs
  • when and how to update charts and versions

Outcome / Acceptance Criteria

Outcome

  • the developer experience is improved

Acceptance Criteria

  • the new changes don't impact app functionality
  • the documentation describes the new functionality in a clear and concise manner

Out of Scope

  • ...

Metadata

Metadata

Assignees

Labels

Type

Projects

Status

In progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions