Skip to main content

Nautilus UI

Nautilus UI

  • Nautilus UI is located in the Atlantis-Component-Library repo alongside efc-atlantis-components and revver-comp-sandbox.

Adding a component

  • Add a folder with the component name under the "src" folder
  • Add the component, story, index, and component specific styling files in the same folder.
    • Example: 
      • Button
        • index.ts
        • Button.tsx
        • Buttom.stories.ts
        • button.scss
  • In the component level index.ts file export the component
    • export { Button } from './Button';
  • In the library level index.ts file add the component export as well
    • export * from './Button';

Run Storybook

  • Make sure you're at the level where you can see the ".storybook" folder and the various config files
    • ....Atlantis-Component-Library\nautilus-ui
  • In your command line simple run: 
    npm run storybook
  • This will automatically spin up the project Storybook on http://localhost:6006/
  • Here's the documentation for more details on Storybook. Get started with Storybook • Storybook docs

Build the library

npm run build

Build the NPM package

Once the PR is approved and merged into main the pipeline will automatically update the NPM package. (This is still a work in progress)