Running & Testing in the Component Library Sandbox

Initial Component Library 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.

Making Component Changes and Testing

• The actual component definitions are in the efc-atlantis-components directory. You can make changes there, and then see them reflected in the sandbox by using Rollup. To do that, navigate to the efc-atlantis-components directory in your command line and run:
  • npm install or npm i (On first time running)
  • npm run build
  • Behind the scenes, this is a script running rollup -c and it is packaging everything up for the sandbox to reference
• If you rerun the sandbox after packaging your changes, you should see them reflected there

Running the Sandbox

• Make sure your packages are up to date and then run the app via Vite. To do that, navigate in your command line to the revver-comp-sandbox directory and input these commands:
  • npm install or npm i (On first time running)
  • npm run dev
• After a few seconds the app should be running, with a localhost port you can visit: http://localhost:5173/