BLiP plugin template
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.
File Structure
Assuming your folder is called blip-plugin-project
.
Whatever name you choose will replace all occurrences of that string in the project
π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
β β ββββπconstants
β β β ββββapplication-actions.js
β β β ββββ...
β β ββββπjest
β β β ββββfileTransform.js
β β ββββπscripts
β β β ββββcharts-config.js
β β βββββοΈappsettings.json
β β ββββindex.js
β ββββπfactory
β β ββββapi.js
β ββββπhooks
β β ββββstore.js
β β ββββuseCombinedReducers.js
β β ββββ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
β β ββββ...
β ββββπstore
β β ββββπactions
β β β ββββapplication.js
β β β ββββ...
β β ββββπreducers
β β β ββββapplication.js
β β β ββββ...
β β ββββconnect.js
β β ββββindex.js
β ββββπutils
β β ββββ...
β ββββApp.js
β ββββindex.js
βββββοΈ.env
βββββοΈ.eslintignore
βββββοΈ.eslintrc
βββββοΈ.gitignore
βββββοΈ.prettierrc
βββββοΈpackage.json
βββββοΈREADME.md
Usage
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 thatcra-template-
prefix is omitted.
Access the project folder.
cd PROJECT_NAME
Configure
./charts
according your project. ReplacePLUGIN_NAME
with the correct plugin name.
npm run config:charts
#or
yarn config:charts
Then, run the project.
npm start
#or
yarn start
Now just add the plugin to your chatbot and enjoy!