Nautilus UI

Nautilus UI

• Nautilus UI is located in the Atlantis-Component-Library repo alongside efc-atlantis-components and revver-comp-sandbox and is the location for new components (pending POC completion).

Initial Setup

• Pull down and open the Atlantis-Components-Library repo
• Get authenticated to Font Awesome globally by inputting these commands into your command line:
  • npm config set "@fortawesome:registry" https://npm.fontawesome.com/
  • npm config set "//npm.fontawesome.com/:_authToken" XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
    • Replace the placeholder with the real auth token, which you can find in the Shared Development Last Pass account under Font Awesome, or by asking someone with access to it.

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)

Team Process for Moving from EFC Component Library to Nautilus UI

After the POC is complete this section will get updated, but for now:

• A list of candidate components will be created that anyone can work on moving over during ILs or as a possible sand item.
  • Items from the EFC Component Library
  • Items that were created in Atlantis-FrontEnd while waiting on Nautilus UI that are intended for the library.
• Any new multi-use components should go directly into Nautilus UI going forward.