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

📦 Breaking out the components into a separate npm package #3416

Open
1 of 11 tasks
jeoffreyfischer opened this issue Dec 17, 2024 · 3 comments
Open
1 of 11 tasks

📦 Breaking out the components into a separate npm package #3416

jeoffreyfischer opened this issue Dec 17, 2024 · 3 comments
Assignees

Comments

@jeoffreyfischer
Copy link
Member

jeoffreyfischer commented Dec 17, 2024

Description

I want to break out new components into a separate NPM package.

Tasks

  • Create the new NPM package structure.
  • Refactor components into the package, ensuring separation of concerns.
  • Update imports in the main project to use the new package.
  • Set up CI/CD pipeline for the package.
  • Write or update documentation for the package.
  • Test the integration of the package with the main project.

Acceptance Criteria

  • A new NPM package is created and published under the organization's registry.
  • Components are refactored out of the main project into the new package, maintaining full functionality.
  • Documentation for the new package includes:
    • Installation instructions
    • Usage examples for each component
    • Versioning guidelines
  • The main project is updated to consume the new NPM package instead of the local components.
  • CI/CD pipeline is set up for the new package to handle:
    • Linting
    • Publishing to the registry
@jeoffreyfischer jeoffreyfischer converted this from a draft issue Dec 17, 2024
@jeoffreyfischer jeoffreyfischer moved this from 🤷‍♂️ Needs Triage to 🔖 Backlog - Ready in SSW.Website Dec 17, 2024
@isaaclombardssw isaaclombardssw moved this from 🔖 Backlog - Ready to 🏗 In progress in SSW.Website Dec 18, 2024
@isaaclombardssw isaaclombardssw moved this from 🏗 In progress to 🔖 Backlog - Ready in SSW.Website Dec 19, 2024
@isaaclombardssw isaaclombardssw moved this from 🔖 Backlog - Ready to 🏗 In progress in SSW.Website Dec 19, 2024
@isaaclombardssw isaaclombardssw changed the title Breaking out the components into a separate npm package 📦 Breaking out the components into a separate npm package Jan 2, 2025
@isaaclombardssw
Copy link
Member

Update – I've created the repo and based it off this package... https://github.com/pcode-at/tinacms-seo.

@Calinator444
Copy link
Member

Calinator444 commented Jan 14, 2025

I've created a repo for building the component library using rollup based on the files @isaaclombardssw provided me with while working on this.

My plan is to get the components working in a state where I can easily import, customize and use them in the Tina starter repo and then publish the package to NPM.

There's still some work that needs to be done because the components don't work very well as standalone components. We also need to make a decision as to whether we should take an opinionated or unopinionated approach to schema management as this will affect developers implement contextual editing.

https://github.com/Calinator444/ssw-consulting-component-lib

Image

Todo: Configure

  • Breadcrumbs
  • Carousel
  • Color Selector
  • Image and text block
  • Ripple button
  • logo carousel

@Calinator444
Copy link
Member

TODO: add custom prefixes to custom tail classes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🏗 In progress
Development

No branches or pull requests

3 participants