Front-end Starter Kit with Gulp for ThemeForest Projects

This project is an opinionated build automation for front-end web development based on Node, Gulp, Yarn, Sass, Babel and Pug for ThemeForest Projects.

Features

• Sass compilation with gulp-sass
• Code linting with stylelint, eslint and pug-lint
• Concatenate the Javascript files with gulp-include
• ES6 transpilation with gulp-babel
• Minification with csso, terser and htmlmin
• Autoprefix CSS with autoprefixer
• Compress images with imagemin
• Pug compilation with gulp-pug
• Tidy Html files with gulp-prettier
• Auto-refresh browser with browser sync
• Show compiled file size with gulp-size
• Output project files in zip file for ThemeForest production with gulp-zip

Requirements

Before you continue, ensure you have meet the following requirements installed:

• Node.js
• Yarn
• Gulp

How to use

1. Clone this repository

   git clone https://github.com/adorade/themy.git my-new-project

2. Open package.json, then edit it with your settings

   ...
   "name": "theme-name",
   "version": "1.0.0",
   "author": {
       "name": "Your Name",
       "email": "your@email.com",
       "url": "https://yoursite.com"
   },
   ...

3. Install the project dependencies

   cd my-new-project
   yarn install

4. Develop awesome things

   # development mode
   yarn run dev
   # or
   gulp
   
   # build theme, use `--theme` flag
   yarn run build:theme
   # or
   gulp build --theme

5. Archive your theme release

   # archive theme release to `archive/stable` folder
   # use `--archive` flag
   yarn run build:archive
   # or
   gulp build --archive

6. Launch your demo

   # production mode, for demo,
   # use `--production` or `--prod` flag
   yarn run build:demo
   # or
   gulp build --prod

Vendors

• jQuery v3.6.1
• popper.js v2.11.6
• Bootstrap v5.2.2

License

See the LICENSE file for license rights and limitations (MIT).