JayBox325 / JayPack

JayBox Webpack framework

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

JayPack 🍾

A Frontend boilterplate using Webpack & Gulp 4. Read the docs in the JayPack Wiki.

Setting up

Project Wrapper

Install the wrapper with npm i.

Project Setup

Install all project dependencies and configure the project with npm run setup.

CraftCMS & Nitro

Run composer create-project JayBox325/JayCraft _craft to install a CraftCMS project in a new directory called _craft.

Set up a CraftCMS Security Key with _craft/craft setup/security-key.

Add this project to Nitro (provided you have it installed and setup on your machine) with nitro add _craft.

If the database prompt doesn't show options, just type 2 for postgres.

Static Projects

Setup TBC

Shopify

Setup TBC

theme open -e development Open the development theme in the browser.

Dependency notes

  • gulp-imagemin installed at 7.0.0 as 8.0.0 is not compatible outside of typescript.
  • If you get a message stating Error: hostname already exists when provisioning the CraftCMS project with Nitro, open Users/.nitro/nitro.yaml and review the list of specified hostnames and either run npm run provision and choose a different hostname for your project, or remove the hostname conflict.

Futures

  • Don't include the _frontend directory by default. Question 1 should be React or Gulp.
    • If react:
      • Clone a NextJS boilerplate.
    • If Gulp:
      • Clone the current Gulp boilerplate into a _frontend dir.
      • Ask questions about Craft/Static/Shopify then clone the appropriate repo.
  • Include themekit in Gulp for shopify projects.
  • Create separate command to provision projects

About

JayBox Webpack framework


Languages

Language:JavaScript 36.3%Language:Nunjucks 35.7%Language:SCSS 15.6%Language:TypeScript 12.3%