cra-template-blip-plugin

KO | EN

gitlite — search

#hacktoberfest #react #golang #android #machine-learning #deep-learning #docker #java #cli #kubernetes #vue #pytorch #security #mcp

cra-template-blip-plugin

(★ 13)

Blip plugin template

cra-template-blip-plugin Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# BLiP plugin template

[![NPM Version][npm-badge]][npm-url]
[![Downloads][npm-downloads-badge]][npm-downloads-url]
[![License][license-badge]][license-url]

BLiP plugin it's a technology-agnostic way to plug unnoficial features to enhance the portal capabilities.

This project aims to give the initial skill needed to develop and build your own plugins.

## Other templates

We have other templates available that you may want to to check:

- [cra-template-blip-plugin-context][plugin-context-api]

## File Structure

Assuming your folder is called `blip-plugin-project`.
Whatever name you choose will replace all occurrences of that string in the project

```json
📁blip-plugin-project
├───📁charts
│   └───📁blip-plugin-project
│       ├───📁templates
│       │   ├───_helpers.tpl
│       │   ├───autoscale.yaml
│       │   ├───deployment.yaml
│       │   ├───ingress.yaml
│       │   ├───NOTES.txt
│       │   ├───secrets.yaml
│       │   └───service.yaml
│       ├───.helmignore
│       ├───Chart.yaml
│       └───values.yaml
├───📁public
│   └───...
├───📁src
│   ├───📁assets
│   │   ├───📁images
│   │   │   └───...
│   │   └───📁styles
│   │        └───app.scss
│   ├───📁components
│   │   └───📁SomeComponent
│   │        ├───SomeComponent.js
│   │        └───index.js
│   ├───📁config
│   │   ├───📁jest
│   │   │   └───fileTransform.js
│   │   ├───📁scripts
│   │   │   └───plugin-config.js
│   │   ├───⚙️appsettings.json
│   │   └───index.js
│   ├───📁constants
│   │   ├───blip-portal-destinations.js
│   │   └───...
│   ├───📁factory
│   │   └───api.js
│   ├───📁hooks
│   │   └───useFetch.js
│   ├───📁pages
│   │   └───📁Home
│   │       ├───📁components
│   │       │   └───📁Header
│   │       │        ├───Header.jsx
│   │       │        └───index.js
│   │       ├───Home.js
│   │       └───index.js
│   ├───📁routes
│   │   ├───Analyticts.js
│   │   ├───index.js
│   │   └───Routes.js
│   ├───📁services
│   │   ├───application-service.js
│   │   └───...
│   ├───📁utils
│   │   └───...
│   ├───App.js
│   └───index.js
├───🐳.dockerignore
├───⚙️.env
├───⚙️.eslintignore
├───⚙️.eslintrc
├───⚙️.gitignore
├───⚙️.prettierrc
├───🐳Dockerfile
├───📃LICENSE
├───⚙️package.json
└───⚙️README.md
```

## Usage

```bash
npx create-react-app PROJECT_NAME --template blip-plugin

#or

yarn create react-app PROJECT_NAME --template blip-plugin
```

> Note: `npx` command installs most recent stable version of CRA from npm. `--template` parameter points to this template, note that `cra-template-` prefix is omitted.

Access the project folder.

```bash
cd PROJECT_NAME
```

> Configure `./charts` according your project. Replace `PLUGIN_NAME` with the correct plugin name.

```bash
npm run config:plugin

#or

yarn config:plugin
```

Then, run the project.

```bash
npm start

#or

yarn start
```

Now just add the plugin to your chatbot and enjoy!

## More information

[Blip plugin template](https://github.com/takenet/cra-template-blip-plugin/tree/main/template)

[npm-badge]: https://img.shields.io/npm/v/cra-template-blip-plugin.svg
[npm-url]: https://www.npmjs.com/package/cra-template-blip-plugin
[npm-downloads-badge]: https://img.shields.io/npm/dt/cra-template-blip-plugin.svg
[npm-downloads-url]: https://www.npmjs.com/package/cra-template-blip-plugin
[license-badge]: https://img.shields.io/github/license/takenet/cra-template-blip-plugin.svg
[license-url]: https://opensource.org/licenses/MIT
[plugin-context-api]: https://github.com/takenet/cra-template-blip-plugin-context

cra-template-blip-plugin

cra-template-blip-plugin Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

cra-template-blip-plugin

cra-template-blip-plugin Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README