Poorvika Components Library
This project was created as a React component library for Poorvika e-commerce app using:
It also features:
- Storybook to help you create and show off your components
- Jest and React Testing Library enabling testing of the components
Development
Testing
npm run test
Building
npm run build
Storybook
To run a live-reload Storybook server on your local machine:
npm run storybook
To export your Storybook as static files:
npm run storybook:export
You can then serve the files under storybook-static
using S3, GitHub pages, Express etc.
Generating New Components
I've included a handy NodeJS util file under util
called create-component.js
. Instead of copy pasting components to create a new component, you can instead run this command to generate all the files you need to start building out a new component. To use it:
npm run generate YourComponentName
This will generate:
/src
/YourComponentName
YourComponentName.tsx
YourComponentName.stories.tsx
YourComponentName.test.tsx
YourComponentName.types.ts
YourComponentName.css
index.ts
The default templates for each file can be modified under util/templates
.
Don't forget to add the component to your src/index.ts
exports if you want the library to export the component!
Installing Component Library Locally
Let's say you have another project (poorvika-web
) on your machine that you want to try installing the component library into without having to first publish the component library. In the poorvika-web
directory, you can run:
npm i --save ../poorvika-components
which will install the local component library as a dependency in poorvika-web
. It'll then appear as a dependency in package.json
like:
...
"dependencies": {
...
"poorvika-components": "file:../poorvika-components",
...
},
...
Your components can then be imported and used in that project.
Publishing
Hosting via GitLab
Build the component library (npm run build
), add, commit and push the contents including build
folder.
You can then install your library into other projects by running:
npm i --save git+https://gitlab.com/just-arun/poorvika-components.git#<branch-name>
Usage
Let's say you created a component called TestComponent
in this repository.
Usage of the component (after the library installed as a dependency into another project) will be:
import React from "react";
import { TestComponent } from "poorvika-components";
const App = () => (
<div className="app-container">
<h1>Hello I'm consuming the component library</h1>
<TestComponent theme="primary" />
</div>
);
export default App;