Skip to main content

Introduction

Read required documentation here https://myunisoft.atlassian.net/wiki/spaces/MYUNISOFT/pages/2609086487/Design+system+documentation

Installation​

Clone the repository then run the following commands.

npm install
cd website && npm install

Quick Start​

yarn add @myunisoft/design-system

Wrap your application with the DSLocaleProvider:

import { DSLocaleProvider } from '@myunisoft/design-system';

const App = () => (
  <DSLocaleProvider locale="fr">
    {/* Your app */}
  </DSLocaleProvider>
);

See DSLocaleProvider for locale sync and wrapping your app. For how DS resolves UI strings (useDSTranslation, internalI18n), see Design System i18n.

Development Setup​

Installation​

Clone the repository then run the following commands.

npm install
cd website && npm install

Start​

Go back to the root folder and run

npm run start

Folder structure​

src​

The src folder contains the files related to the package. Only those files will be part of the npm package.

website​

The website folder contains all the documentation and components used as examples.

Most of the time, you'll only need to work inside the website/docs/ and website/src/components/ folder.