Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 986 Bytes

CONTRIBUTING.md

File metadata and controls

37 lines (23 loc) · 986 Bytes

Contributing to P.R.I.M.E

Please follow these instructions for contributing to PRIME.

Getting started

To run the Storybook page locally, pull down the project and run:

npm install
npm run storybook

Playground

To use the Vue playground

npm start

Then navigate to http://localhost:5173/playground/index.html

More detailed docs exist on the storybook.

Creating a component

  1. Create a new component directory and index.svelte file in /elements
  2. Create a new [component].stories.mdx file in /stories
  3. Import the component in main.ts
  4. Import the addStyles() helper in lib/ to the component to add the shared component stylesheet

Further Reading

Linked below are some articles that provide knowledge for how to best build reusable, generic web components.