-
Notifications
You must be signed in to change notification settings - Fork 16
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
116 - Publish npm package for the design system #141
116 - Publish npm package for the design system #141
Conversation
- @iqss/[email protected]
- @iqss/[email protected]
- @iqss/[email protected]
- @iqss/[email protected]
I created the test app and imported the package following the steps and it works great! page.tsx code:
|
@@ -11,20 +11,27 @@ jobs: | |||
|
|||
- uses: actions/setup-node@v3 | |||
with: | |||
node-version: 19 | |||
node-version: 18 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why downgrade?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The rest of the workflows are using node 18, and the lint workflow was failing, so I thought that could be the issue. But it wasn't. So we can go back to 19, although I think that all workflows should run on the same node version. And also I'm running node 18 in my machine
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good and works great!
…-for-the-design-system 116 - Publish npm package for the design system
What this PR does / why we need it:
This PR publishes the Dataverse Design System to the npm registry. It includes the necessary changes and configurations to publish the design system components and make them available as an npm package.
Which issue(s) this PR closes:
Closes #116
Special notes for your reviewer:
The automation of the publishing will be developed in this other issue:
The creation of a test registry will be developed in this other issue:
To publish a new version of the package you need to be registered in the npmjs.com IQSS organization. Contact me via slack so I can send you the invite!
Suggestions on how to test this:
Test the published package
To test the package:
npx create-next-app
in your machine (ensure you have node installed in your machine)npm i
to install all the packages of the demo appnpx create-next-app
then go to thesrc/app/page.tsx
fileimport { Col, Container, Form, Row} from "@iqss/dataverse-design-system";
. If you are using next-js you'll need to set'use client'
at the top of the file since the design system components are client componentssrc/app/page.tsx
filenpm run dev
and go to http://localhost:3000 to see the application using the design system componentsDoes this PR introduce a user interface change? If mockups are available, please link/include them here:
None
Is there a release notes update needed for this change?:
Published first version of the Dataverse Design System to the npm registry @iqss/dataverse-design-system
Additional documentation:
Lerna publishing