Convergence

• 📦 Toolkit: Convergence
• 🏗️ Version: 7.1.4
• 👨‍💻 Author: VQH-cmd

---

[01]: Description

• A toolkit for Monolith template.
• Inspired by: Captain Panic! & Systek - [Monolith]: Convergence)
• Everything is Connected: One Package connect to many projects !

---

---

[02]: Installation

💼 Base	🔗 Link
Node.js	https://nodejs.org (16.x.x)
gulp.js	https://gulpjs.com

Location

Put the Convergence anywhere in your device. Ex: D:/toolkit/Convergence

Install Commands (Terminal):

Recommended !

yarn install

npm install

Use the command set-executionpolicy remotesigned in the Windows Powershell if you see

gulp.ps1 cannot be loaded because running scripts is disabled on this system

in the Terminal.

Then cd command it every time using. Ex:

cd D:/toolkit/Convergence

---

[03]: Support

HTML
Pug
CSS
SASS/SCSS
JavaScript (Not Recommended) [ .js ]
TypeScript (Recommended) [ .ts ]
React [ .jsx .tsx ]
PHP
localhost
ftp
WordPress
Shopify
TheBASE

---

[04]: Commands & Description

Use the Terminal to execute the commands.

📟 Overall Commands	📝 Description
gulp <command> --p <DEST> --env <env>	Use the Toolkit.
ncu	Check Update.

📟 <command>	📝 Description
b	Build
w	Watch
css	Run CSS task only
css_c	Run custom CSS task only
js	Run JavaScript task only
js_c	Run custom JavaScript task only
pug	Run Pug task only
ftp	Upload on FTP server
clean	Remove the temporary files
clean_all	Remove all generated files

📟 <env>	📝 Description
development / dev / d	Development (default, no need to write --env)
production / prod / p	Production

If Shopify, the value in shopify.yml

<DEST> = Destination. Example:
gulp b --p D:/Project/example_x
gulp b --p D:/Shopify/example_x --env prod

---

[05]: Repository tree

All files in /build folder shall be converted into /assets folder.

📦 [Pack]: Assets & Build

• .../
  • /assets (assets)
  • /build (build)
    • /config (Config Folder)
      • breakpoint.json (CSS Breakpoint Responsive)
      • config.json (Convergence's Config)
      • ftp.json (FTP Config)
      • misc.json (SASS Config)
      • theme.json (Themes/Colors Config)
      • whitelist.json (PurgeCSS config)
    • /js (JavaScript + TypeScript)
      • /components
      • /libs (JavaScript Library, support {.js, .ts})
      • /script (shall export individual files)
      • script.ts
    • /pug (Pug)
    • /sass (SASS)
      • /style (shall export '*.style.css' files)
      • style.sass
    • /img (Image [Optional])
  • /docs (identify)
  • .editorconfig

---

default: Front-End, PHP, WordPress

• Project_Name/ (also the root)
  • 📦[Pack]
  • /data (database)
  • /docs (information about the Project)
  • /inc (include PHP files)
  • /locale (internationalization)
  • .htaccess
  • robots.txt
  • ...

---

Shopify

• Project_Name/ (also the root)
  • 📦[Pack]
  • /config (Shopify)
  • /layout (Shopify)
  • /locales (Shopify)
  • /sections (Shopify)
  • /snippets (Shopify)
  • /templates (Shopify)
  • shopify.yml (Shopify config)

---

TheBASE

• Project_Name/ (also the root)
  • 📦[Pack]
  • theme.html (result)

---

[06]: Download

Download link in any Monolith project via this location:

• Project_Name/ (also the root)
  • /build
    • convergence.yml

---

Copyright © 2018 - 2021, VQH-cmd.