@asirsamr/rishon-basekit

A production-ready React component library for Rishon Communications.

Features

• Fully tree-shakeable ES modules.
• Built with Vite for ultra-fast compilation.
• Pre-configured CodeDiffViewer with react-ace integration.
• Configurable API client built in.

Installation

Install the package via npm:

npm install @asirsamr/rishon-basekit

Ensure you have the required peer dependencies installed:

npm install react react-dom

Usage Example

import React from 'react';
import { CodeDiffViewer } from '@asirsamr/rishon-basekit';

// Import CSS if components rely on bundled CSS
import '@asirsamr/rishon-basekit/style.css'; 

const MyComponent = () => {
    return (
        <CodeDiffViewer 
            api="/api/v1/diff"
            filterData={{ id: 123 }}
            mode="javascript"
            theme="monokai"
            height="500px"
        />
    );
};

export default MyComponent;

Local Development

To run the library locally and test changes:

1. Clone the repository and install dependencies:

   cd rishon-basekit
   npm install

2. Run Vite in watch mode (if testing with an external app via npm link):

   npm run build -- --watch

Build Instructions

To create a production build of the library:

npm run build

This generates ES Module (.es.js) and UMD (.umd.js) bundles in the dist folder.

Publishing to npm

1. Ensure your working directory is clean.
2. Build the project: npm run build
3. Login to npm (if not already): npm login
4. Publish the package: npm publish --access public

Folder Structure

rishon-basekit/
├── src/
│   ├── components/       # UI Components
│   │   └── CodeDiffViewer/
│   ├── models/           # Data Models
│   ├── services/         # API and external integrations
│   └── index.js          # Main library export
├── package.json
└── vite.config.js

Adding New Components

1. Create a new folder under src/components/.
2. Add your .jsx and .css files.
3. Export the component from an index.js file within that folder.
4. Export the component publicly in src/index.js.
5. Rebuild the library using npm run build.