techbootstrap-import-mate

TechBootstrap Import Export Mate Library

TechBootstrap's Import Mate Library is a core component of TechBootstrap's import-export product. It provides tools for both administrators and end-users to manage data import and export workflows with ease.

Overview

This library consists of three main components:

1. Admin Component:
   Designed for administrators to configure data sources and fields for data import.
   Usage:

   <app-tb-import-mate [apiBasePath]="_apiBasePath" [bearToken]="_bearToken"></app-tb-import-mate>

2. Client Import Component:
   Built for end-users to download CSV templates for specific modules, populate them with data, and upload them back into the system.
   Usage:

   <app-tb-import-client [apiBasePath]="_apiBasePath" [bearToken]="_bearToken"></app-tb-import-client>

---

3. Client Export Component:
   Built for end-users to select a specific module, pick fields that require to be in CSV file and Export them.
   Usage:

   <app-tb-export-client [apiBasePath]="_apiBasePath" [bearToken]="_bearToken"></app-tb-export-client>

---

Installation

To install this package, use the following command:

npm install @techbootstrap/import-mate

---

Getting Started

1. Admin Component

The admin component enables administrators to:

• Set up data sources.
• Define fields for importing data.
• Manage relational configurations.

Include the following tag in your Angular application:

<app-tb-import-mate [apiBasePath]="_apiBasePath" [bearToken]="_bearToken"></app-tb-import-mate>

2. Client Import Component

The client component allows your end-users to:

• Select a module.
• Download a CSV template for that module.
• Upload the completed CSV file.

Add the following tag in your Angular application and provide the required inputs:

<app-tb-import-client [apiBasePath]="_apiBasePath" [bearToken]="_bearToken"></app-tb-import-client>

Inputs:

• apiBasePath: The base path of the API for the library to communicate with.
• bearToken: The authorization token required for secure API communication.

---

3. Client Export Component

The client component allows your end-users to:

• Select a module.
• Select Fields to include in downlaod file.
• Download CSV file.

Add the following tag in your Angular application and provide the required inputs:

<app-tb-export-client [apiBasePath]="_apiBasePath" [bearToken]="_bearToken"></app-tb-export-client>

Inputs:

• apiBasePath: The base path of the API for the library to communicate with.
• bearToken: The authorization token required for secure API communication.

---

Sample TS content

import { Component } from '@angular/core';
import { RouterOutlet } from '@angular/router';
import { TechbootstrapImportMateModule } from 'techbootstrap-import-mate';

@Component({
  selector: 'app-root',
  standalone: true,
  imports: [RouterOutlet, TechbootstrapImportMateModule],
  templateUrl: './app.component.html',
  styleUrl: './app.component.css'
})
export class AppComponent {
   title = 'my-plugin-workspace';
  _apiBasePath="http://localhost:3000";//ImportMate Backend Application Path
  _bearToken="your application bearer token";
}

Contact Information

This library is part of TechBootstrap's import-export product. For full usage details or inquiries, please reach out to:

• Arfan: [e-mail]
• Arfan's Alternate Email: [e-mail]
• Visit at https://techbootstrap.com/import-mate/

---

License

This library is licensed under the MIT License. See the LICENSE file for more details.