Development

This document describes the process for running this application on your local computer.

Getting started

It runs on macOS, Linux environments (should work on windows).

none of the developers nor our workflows run windows, we encourage running windows subsystem.

if your a windows user and has a MS inter-opt fix, we welcome PR`s 😇

You'll need Node.js to run the site. Check the version in package.json. To install Node.js, download the "LTS" installer from nodejs.org. If you're using nodenv, read the nodenv docs for instructions on switching Node.js versions.

This repo uses the package manger pnpm, see installation guide

Once you've installed Node.js and pnpm, open Terminal and run the following:

  # clone repo
  git clone https://github.com/equinor/fusion-framework
  # install packages
  pnpm install
  # build all packages
  pnpm build

Repo structure

• 🗂️ Cookbooks - collection of sample code
• 🗂️ Packages - @equinor/fusion-framework-{FOLDER}
  • 📦 App - base wire for applications
  • 📦 CLI - tooling for building application
  • 📦 Framework - root initiator (portal)
  • 🗂️ Modules - collection of modules
  • 🗂️ React - collection of tooling for React
    • 📦 App - tooling for apps
    • 📦 Framework - tooling for root initiator (portal)
    • 🗂️ Modules - collection of modules with tooling
  • 🗂️ Utils - collection of utilities

READMEs:

• code-standards
• self-review
• cookbooks
• changeset
• git-workflow