well-correlation-panel v0.0.1
Well Correlation Panel
well-correlation-panel is a TypeScript (React) component library for use in subsurface related dashboards.
🚀 Getting started
- Clone this repo
$ git clone git@github.com:equinor/well-correlation-panel.git - Install dependencies by running
npm install - Start up the development server by running
npm run dev
Storybook
Storybooks with examples may be found here: https://equinor.github.io/well-correlation-panel/storybook-static-main/
💻 Technology stack
Development environment
Vite.js is used as the local development server.
User interface and components
React with SWC option instead of Babel is used for the user interface.
Testing
Vitest is a framework for unit testing that is built for Vite, so testing this instead of Jest (Jest and Vite have a lot of duplication between them).
In addition to Vitest, React Testing Library is used for testing React components.
Styling
This repository currently use different methods for styling (plan to land on one of these).
CSS modules since it's already out of the box with Vite
Styled components since we update property values a lot. With styled components this is easy to do and easy to follow either with built-in props option or with CSS variables