Skip to main content

Client

Packages​

portal-client​

The Portal Client Project is client application published at project.fusion.equinor.com. It is built using uses the various packages in the client/packages. Each package will get a small description below.

Components​

This project houses reusable React components, ensuring a consistent and modular design throughout the application. These components can be easily integrated into the portal client. This project can utilize functionality from therese packages:

  • @portal/core
  • @portal/ui
  • @portal/utils
  • @portal/type

Core​

This project contains fundamental functionalities and business logic that are critical to the application's operation. It serves as the backbone, orchestrating various processes and ensuring the smooth flow of data and interactions.

This project can utilize functionality from therese packages:

  • @portal/utils
  • @portal/type

We should try to keep the core package as clean as possible regarding internal dependencies.

Ui​

The UI project is dedicated to user interface elements and styling. It encapsulates styles, and UI-related assets, fostering a cohesive and visually appealing design across the application. There should be no business logic in these components.

This project can utilize functionality from therese packages:

  • @portal/utils
  • @portal/type

Utils​

Utilities, or Utils, encompass a set of helper functions and tools that are utilized across different parts of the application. This module promotes code efficiency by providing a centralized location for commonly used functionalities.

Types​

Typescript types are crucial for maintaining a strong and statically-typed codebase. The Types module includes type definitions that enhance code clarity, readability, and catch potential errors during development.

Packages to be Deprecated​

There are som packages that still have som unsorted code we should move the code as soon as possible in to re respective projects. But the code needs to be slit up and refactors if needed before moving the code.

  • portal-core
  • portal-pages
note

This will be renamed form portal-pages to pages. and Will be collection of projects each containing one page

  • portal-ui
note

This will deprecated and code vil be moved to Component and UI

  • service-message
  • notification
note

This should be moved in to widgets folder at some point.