ReUp Web Components
Overview
ReUp Web Components is a collection of reusable React components built in TypeScript. It is designed to be used in buyer and seller e-commerce platforms. This README provides instructions on how to update the library and how to use it in your projects.
Installation
To use this library in your project, you'll either need to first login to npm if you're inside the npm organization holding this package, or you can place a .rpmc file in your codebase with the following auth token:
//registry.npmjs.org/:_authToken=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
you can install it from your private npm registry:
npm install @mekaknepley/reup-web-components-private
Usage
Import and use the components in your React application:
import React from 'react';
import { Button, InputField } from '@mekaknepley/reup-web-components-private';
function MyComponent() {
return (
<div>
<Button>Click me</Button>
<InputField placeholder="Enter something" />
</div>
);
}
export default MyComponent;
Updating the Library
If you need to make changes to the library, follow these steps:
Clone the library repository:
git clone https://github.com/JoinReUp/reup_web_components.git
cd reup_web_components
Make the required changes to the library components.
Link the library to your local development environment:
npm link
Navigate to the root directory of your buyer or seller app.
Link the library to your app:
npm link @mekaknepley/reup-web-components-private
This locally connects the package to your working app.
Test your changes in the app to ensure they work as expected.
Once the update is confirmed, update the version number in the package.json of your library.
Publish the updated version to your private npm registry with private access:
npm publish --access=restricted
Ensure that the package always has private access to protect sensitive code and assets