ChainSafe UI Monorepo

Mono Repo Structure 🏗

The repository is broken up into packages, managed using yarn workspaces. You can find these in the packages directory. These packages are as follows:

packages/common-components

Various components (atoms/molecules) that are used in the development of UI's. This package forms the base of the UI providing composable components, form elements, icons, small scope elements.

packages/common-theme

Theme context and other utilities for generating and using the theming capabilities

packages/files-ui

The UI for Chainsafe Files

packages/storage-ui

The UI for Chainsafe Storage

Development

Requirements:

• Node > 12
• Yarn > 1

Run

• Run yarn at the root to install all project dependencies
• Run yarn start:storybook to start the component storybook
  OR
• Create a packages/files-ui/.env based on packages/files-ui/.env.example
• Run yarn start:files-ui to start the development server.

Run Tests

Our tests use Cypress running against the local instance of the Files UI. The files UI needs to run before the test are launched. By default the tests are run against localhost:3000

• To start the tests UI run yarn test:files-ui
• To start all the tests like in CI run yarn test:ci:files-ui

License

All the code in this repository is licensed under the GNU Lesser General Public License v3.0 also included in our repository in the LICENSE.md file

© Copyright Protected & All Rights Reserved by ChainSafe Systems