NXTVid Component Library

⚠️ DISCLAIMER
This package is NOT production-ready and is intended for internal use only at NXTVid. It is unlicensed, meaning you do not have permission to use, distribute, or modify this package if you are not part of NXTVid.

Overview

This repository is for building and testing reusable components for the NXTVid platform. The components are designed to be tested, versioned, and integrated across NXTVid projects using NPM.

Workflow

Follow this workflow to contribute a new or updated component:

1. Write and Test Components

   • Build your component .jsx file and its corresponding .css file.
   • Write unit tests for your component in Component.test.js (using Jest and React Testing Library).
   • Run tests locally:

     npm test

2. Build Stories

   • Create component stories in Component.stories.js for Storybook to visualize your component.
   • Start Storybook locally to test and interact with the component:

     npm run storybook

3. Prepare for Merge

   • Create a new branch from dev for your component or update:

     git checkout dev
     git pull origin dev
     git checkout -b component/<component-name>

     • Use component/<component-name> for new components.
     • Use update/<component-name> for updates to existing components.
   • Push your changes and create a pull request for review.

4. Code Review and Merge

   • Submit your branch for code review.
   • After approval, merge into dev.

5. Test and Validate

   • Run tests throughout the development process:

     npm test

6. Merging dev into main

   • Once dev is stable, create a pull request to merge dev into main.
   • Ensure tests pass and the code is reviewed before merging.

Repository Access and Contribution

• Repository: NXTVid-Inc/component-library
• Developers must not push directly to main or dev. All changes must go through feature branches and pull requests.
• Only approved PRs will be merged into dev, and stable releases will be merged into main.

Access the Package via NPM

To use components from this library in your project:

1. Install the Package
   Add the component library as a dependency:

   npm install @nxtvid/component-library