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 design system package #2

Merged
merged 1 commit into from
Jun 5, 2024

Conversation

arkadiuszbachorski
Copy link
Collaborator

@arkadiuszbachorski arkadiuszbachorski commented Jun 3, 2024

Create design system package

♻️ Current situation & Problem

We need separate package with design system components and instructions to reuse.

⚙️ Release Notes

  • Create design system package

📚 Documentation

  • Adds design-system module
  • Removes example module
  • Adds Button component with storybook, tests, cva. Blueprint for future components

Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

Copy link

codecov bot commented Jun 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@5f7feb8). Learn more about missing BASE report.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff            @@
##             main        #2   +/-   ##
========================================
  Coverage        ?   100.00%           
========================================
  Files           ?         5           
  Lines           ?        34           
  Branches        ?        10           
========================================
  Hits            ?        34           
  Misses          ?         0           
  Partials        ?         0           
Files Coverage Δ
app/page.tsx 100.00% <ø> (ø)
...ges/design-system/src/components/Button/Button.tsx 100.00% <100.00%> (ø)
...ign-system/src/components/Button/ButtonPending.tsx 100.00% <100.00%> (ø)
...ages/design-system/src/components/Button/index.tsx 100.00% <100.00%> (ø)
packages/design-system/src/utils/className.ts 100.00% <100.00%> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5f7feb8...86d6933. Read the comment docs.

@arkadiuszbachorski arkadiuszbachorski force-pushed the arek/create-design-system-package branch 9 times, most recently from 34a7544 to db9300a Compare June 4, 2024 22:15
.eslintrc.json Show resolved Hide resolved
jest.config.js Show resolved Hide resolved
package.json Show resolved Hide resolved
packages/design-system/package.json Show resolved Hide resolved
tsconfig.json Outdated Show resolved Hide resolved
@arkadiuszbachorski arkadiuszbachorski marked this pull request as ready for review June 4, 2024 22:17
Copy link
Member

@PSchmiedmayer PSchmiedmayer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job with the changes and the start of the design system. It will be great to have that as a reusable set of components for multiple projects in the future!

In some conversations with @vishnuravi and @NikolaiMadlener we discussed it it makes sense to utilize and build on top of something like https://ui.shadcn.com/docs for the different components as a head start if needed.
They seem to be MIT licensed and therefore easily integrated with a proper acknowledgement.

Would be great to hear your thoughts on the advantages/disadvantages and if that might be useful for some elements?

packages/design-system/package.json Show resolved Hide resolved
packages/design-system/README.md Outdated Show resolved Hide resolved
@arkadiuszbachorski
Copy link
Collaborator Author

In some conversations with @vishnuravi and @NikolaiMadlener we discussed it it makes sense to utilize and build on top of something like https://ui.shadcn.com/docs for the different components as a head start if needed. They seem to be MIT licensed and therefore easily integrated with a proper acknowledgement.

Would be great to hear your thoughts on the advantages/disadvantages and if that might be useful for some elements?

Yes, I will be using shadcn/ui as starting point for many components. It's a great, modern library with a lot of good practices baked in. There are basically no disadvantages. I've been using shadcn/ui and Radix headless lib for a long time and I consider it best way to build.

@arkadiuszbachorski arkadiuszbachorski force-pushed the arek/create-design-system-package branch from db9300a to 86d6933 Compare June 5, 2024 06:50
@arkadiuszbachorski arkadiuszbachorski merged commit bc23665 into main Jun 5, 2024
10 checks passed
@arkadiuszbachorski arkadiuszbachorski deleted the arek/create-design-system-package branch June 5, 2024 06:54
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.

2 participants