@skedulr/nebula-ui-library v0.8.17
Welcome to Nebula, the UI library for Skedulr. Below you'll find instructions on how to use and deploy Nebula components efficiently.
🚀 Quick Start
1. Install Dependencies
Ensure you have Yarn installed. If not, you can install it by following the instructions below:
For macOS and Linux users, open the terminal and run:
sudo npm install --global yarn
For Windows users, download the Yarn package installer from the official website.
Then, install the project dependencies:
yarn
2. Adding New Components
When adding a new component to Nebula, consider its reusability. Follow these steps to set up a new component:
- Create a folder with the component name.
- Include the JSX file, a styles file, and a
stories.jsx
file. - Utilize Emotions for styling.
Ensure each component has comprehensive documentation on usage and controls for easy exploration from the Storybook page.
3. Pull Requests
- Upon creating a PR, the Chromatic workflow will run for visual checks. Reviewers should approve visual changes through Chromatic in addition to code review.
- After PR approval, add the appropriate label:
Minor
for non-breaking changes andMajor
for breaking changes. This is crucial for version incrementation, and failure to label may result in a publishing failure.
Automation
Chromatic Workflow
- We Push changes to Chromatic to check for visual changes and publish them.
- You can retrieve the URL from Chromatic to share with testers/reviewers.
Auto Workflow
- We utilise the
push.yml
workflow for Auto to increment and publish the package to NPM upon merging to the master branch. - Make sure to write descriptive commits as this is used for release notes.
10 months ago
8 months ago
11 months ago
11 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago