About

Scylla is an open source UI Components Library that used on Delos Web App.

Requirements

• Node v16+
• Currently, Scylla is designed for React based project. You will need to install React in your project to use this component library.

How To Initiate

To use Scylla, follow these steps:

1. Install Scylla using npm

npm install @delosaqua/scylla

or

yarn add @delosaqua/scylla

2. Update the script on your package.json file, to add default scylla font and locale into your project.

{
    ...
    "script": {
        ...
        "scylla:init": "scylla-cli init"
    }
}

3. Run the script.

npm run scylla:init

4. Define Scylla Provider into your root project

import { ScyllaProvider } from '@delosaqua/scylla';
import { ScyllaChartProvider } from '@delosaqua/scylla/charts';  
// if you are planning to use chart by Scylla

function App({ Component, pageProps}) {
    return (
        <ScyllaProvider>
          <ScyllaChartProvider>
            <Component {...pageProps} />
          </ScyllaChartProvider>
        </ScyllaProvider>
    )
}

Storybook / Documentation

Scylla comes with a Storybook, which allows you to view and interact with each component in isolation. You can view the storybook documentation for Scylla by visiting Scylla Storybook Documentation.