payplug-ui-plugins-bo
v2.2.1
Published
V2.0.0
Readme
payplug-ui-plugins
V2.0.0
PayPlug design library for CMS (specially Woocommerce and PrestaShop)
Getting started
cd existing_repo
git remote add origin https://github.com/payplug/payplug-ui-plugins.git
git branch -M master
git push -uf origin masterProject setup
###Prerequisites: Familiarity with the command line
Install Node.js version 16.0 or higher
npm installCompiles and hot-reloads for development
npm run serveCompiles and minifies for production depending on your environment
npx vue-cli-service build --mode environment_fileRun Storybook
npm run storybookLints and fixes files
npm run lintEnvironment variables
VUE_APP_ENV=sandbox
VUE_APP_LOGIN
VUE_APP_OAUTH_LOGIN
VUE_APP_LOGOUT
VUE_APP_INIT
VUE_APP_BANCONTACT
VUE_APP_DEFERRED
VUE_APP_ONE_CLICK
VUE_APP_INSTALLMENT
VUE_APP_AMERICAN_EXPRESS
VUE_APP_ONEY
VUE_APP_APPLE_PAY
VUE_APP_INTEGRATED
VUE_APP_SATISPAY
VUE_APP_MYBANK
VUE_APP_SOFORT
VUE_APP_GIROPAY
VUE_APP_IDEAL
VUE_APP_REQUIREMENTS
VUE_APP_REFRESH_KEYS
VUE_APP_SAVE
VUE_APP_TELEMETRYEnvironment files available
.env - environment file, used in development, get from project file
.env.prestashop - environment file, used for prestashop project
.env.woocommerce - environment file, used for woocommerce project
Build Command
ENV=woocommerce npm run build - for woocommerce env file
ENV=prestashop npm run build - for prestashop env file
NB: ENV is not mandotory, if not specified, .env file will be used
Integrate with your framework
- Copy the compiled files into your project.
- include them into your code. eg for woocommerce:
wp_enqueue_script('chunk-vendors.js', PAYPLUG_GATEWAY_PLUGIN_URL . 'assets/dist/js/chunk-vendors-0.1.1.js', [], PAYPLUG_GATEWAY_VERSION);
wp_enqueue_script('app.js', PAYPLUG_GATEWAY_PLUGIN_URL . 'assets/dist/js/app-0.1.1.js', [], PAYPLUG_GATEWAY_VERSION);
wp_enqueue_style('app.css', PAYPLUG_GATEWAY_PLUGIN_URL . 'assets/dist/css/app.css', [], PAYPLUG_GATEWAY_VERSION);Support
Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
