Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create style guide basics #2

Merged
merged 12 commits into from
Sep 23, 2024
Merged

Create style guide basics #2

merged 12 commits into from
Sep 23, 2024

Conversation

claireolmstead
Copy link
Collaborator

Goal

The goal of this PR is to create a package we can release to setup the basics of our style guide.

Closes #1

Discussion

Currently the components are loading into /src in the package, so you have to reference that path when importing a component. Is there a way to avoid that?

Checklist

  • Created Buttons
  • Created Typography
  • Created tailwind.config
  • Created tailwind classes and initial styles

How To Test the Changes

  1. Create package
  2. Install package
  3. Use package

@claireolmstead claireolmstead self-assigned this Sep 20, 2024
@claireolmstead claireolmstead linked an issue Sep 20, 2024 that may be closed by this pull request
package.json Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
@JoeCap08055
Copy link
Contributor

Great work!

Am I right in assuming that a consumer of the package would not be interested in the Storybook UI (that's more for exploring the styles in this repo)? And that the consumer is really mostly interested in the base component/color/font definitions? If that's true, it might be best to separate that out into separate packages, so that the published package only contains the core components and not the Storybook UI. Take a look at the SIWF repository; that's also a Vite/Svelte project with separate packages; some of which are published & some that aren't.

If that's the route we think we want to go, I'd be okay with merging this & make that the subject of a subsequent issue/PR.

claireolmstead and others added 2 commits September 23, 2024 09:02
Co-authored-by: Joe Caputo <[email protected]>
Co-authored-by: Joe Caputo <[email protected]>
@JoeCap08055
Copy link
Contributor

Great work!

Am I right in assuming that a consumer of the package would not be interested in the Storybook UI (that's more for exploring the styles in this repo)? And that the consumer is really mostly interested in the base component/color/font definitions? If that's true, it might be best to separate that out into separate packages, so that the published package only contains the core components and not the Storybook UI. Take a look at the SIWF repository; that's also a Vite/Svelte project with separate packages; some of which are published & some that aren't.

If that's the route we think we want to go, I'd be okay with merging this & make that the subject of a subsequent issue/PR.

Linked to #13

claireolmstead added a commit that referenced this pull request Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create Basics + v1 release
2 participants