analyst-component-library v1.23.2
Analyst Wesbite Component Library
📖 Storybook
Storybook can be viewed at https://stage-dataviz.theanalyst.com/storybook/
📦 Publishing a New Version
Run the release script:
npm run release
The script will:
- Prompt you to select the version bump type (
patch
,minor
, ormajor
). - Update the
package.json
version. - Commit the changes and create a new Git tag (e.g.,
v1.1.0
). - Push the changes and the tag to the repository.
- Prompt you to select the version bump type (
The GitHub Actions workflow will automatically publish the new version to npm.
🚀 Generating a New Component
Run the Script:
npm run generate
Enter the Component Name:
- Provide the component name in PascalCase (e.g.,
MyNewComponent
) when prompted:Enter the component name in format ComponentName: MyNewComponent
- Provide the component name in PascalCase (e.g.,
Files Created: The following files will be generated under
src/components/MyNewComponent
:src/ components/ MyNewComponent/ index.jsx MyNewComponent.module.scss stories/ MyNewComponent.stories.js
Export Added: The script automatically adds the export to
src/index.js
:export { MyNewComponent } from './components/MyNewComponent';
🛠️ TODOs for Repository Improvement
Our goal is to enhance the quality, maintainability, and efficiency of the codebase. Here is our rough roadmap:
🚧 TODO
- Decouple Business Logic: Remove business logic from components, making them pure and focused on rendering only.
- Switch to TypeScript: Convert JavaScript code to TypeScript for better type safety and improved development experience.
- Rewrite and Clean Up Code: Improve code quality and remove outdated components, with a detailed breakdown:
- Remove Unused Components: Identify and delete components that are no longer in use.
- Remove Unused Code: Find and remove code that is no longer necessary or relevant.
- Rewrite Outdated Components:
- Tables: Rewrite and modernize the table components.
- Remaining Components: Refactor and improve other components as needed.
- Style Consistency Low Priority: Switch to Tailwind CSS or a similar framework for consistent styling across components.
- ...
✅ Completed
- Automated Release Process: Create a release script for a smoother and simpler release process.
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
6 months ago
6 months ago
6 months ago
5 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
8 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
11 months ago
11 months ago
11 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
1 year ago
12 months ago
1 year ago
12 months ago
1 year ago
12 months ago
12 months ago
1 year ago
12 months ago
12 months ago
1 year ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
12 months ago
12 months ago
12 months ago
12 months ago
11 months ago
11 months ago
12 months ago
12 months ago
12 months ago
12 months ago
1 year ago
12 months ago
12 months ago
11 months ago
12 months ago
11 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
11 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 months ago
12 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