[PRIO 2] Local development setup

ds-ashanmugavel commented 8 months ago

As a contributor I want to start backend and frontend locally so that I can participate on the development on trace-x on local resources

Link

Is blocked by https://github.com/eclipse-tractusx/traceability-foss/issues/728

Hints / Details

As a reference, should already be implemented by cofinity: https://github.com/Cofinity-X/cofinity-x-ba-traceability-foss

Acceptance Criteria

[x] HELM Chart realization to be reused
[x] Backend can be started locally
[x] Frontend can be started locally
[x] Required shared services like (irs, dtr, semantic hub,edc) could be used in local setup (mocks or instances)
[x] Frontend can use local deployed backend
[x] External services connected to the backend will be returning mock responses
[x] Authentication against the portal is not necessary
- [x] All roles (admin, user, supervisor) MUST be used
[x] Local deployment is documented in a sufficient way for external contributors
[x] Upload test data
[x] Document how to set up (updated)
- [x] Define what is out of scope and working
- [x] INSTALL.md

Out of Scope

Notification flow up and running
IRS Sync up and working

ds-ext-sceronik commented 6 months ago

@mkanal @jzbmw @ds-mwesener for local deployment if We should first consider reducing number of used EDCs from 2 to 1 to use only one instance of EDC for consuming and providing purpouses.

Also question if local setup should be single instance or 2 instances deployed and configured that way so it would be possible to send notifications between them ?

ds-mwesener commented 6 months ago

To be discussed.

mauantoniojw commented 6 months ago

in case is helpful, a wiremock image can be useful to mock external services like irs, edcs, etc. keycloak is something the local environment can also run for auth (realm file that includes Supervisor, User and Admin)

mkanal commented 6 months ago

We have resolved the discussion by adding story #728 which corrects the edc notification flow. Discussion label was removed.

ds-lcapellino commented 5 months ago

Also update the INSTALL.md file in order to have an up to date tutorial.

ds-lcapellino commented 4 months ago

As discussed in today's daily, we moved this issue to the current sprint.

ds-jhartmann commented 1 month ago

Created a configuration for trace-x in the umbrella repository: https://github.com/eclipse-tractusx/tractus-x-umbrella/tree/chore/trace-x-integration Added frontend configs and documentation how to use the umbrella chart in https://github.com/eclipse-tractusx/traceability-foss/pull/1268

[x] HELM Chart realization to be reused
[x] Backend can be started locally (as part of umbrella chart)
[x] Frontend can be started locally
[x] Required shared services like (irs, dtr, semantic hub,edc) could be used in local setup (mocks or instances)
[x] Frontend can use local deployed backend (backend as part of umbrella chart)
[x] External services connected to the backend will be returning mock responses
[x] Authentication against the portal is not necessary
- [x] All roles (admin, user, supervisor) MUST be used
[x] Local deployment is documented in a sufficient way for external contributors
[x] Upload test data
[x] Document how to set up (updated)
- [x] Define what is out of scope and working
- [x] INSTALL.md

ds-mwesener commented 1 month ago

Story is done. Please validate or move to done. Thanks

eclipse-tractusx / traceability-foss