Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tagtwp/gulp-bootstrap-starter

Gulp V5 Starter for a quick development start. Automated build simplifies with Jquery, Bootstrap development, letting focus on quality code.
https://github.com/tagtwp/gulp-bootstrap-starter

bootstrap gulp gulp-bootstrap-starter gulp-plugin gulp-starter gulp-starter-kit gulp5 gulpjs starter

Last synced: 4 days ago
JSON representation

Gulp V5 Starter for a quick development start. Automated build simplifies with Jquery, Bootstrap development, letting focus on quality code.

Awesome Lists containing this project

README 

        
gulp-bootstrap-starter Stars Badge

=== 



Installation

---------------



### Requirements



`gulp-bootstrap-starter` requires the following dependencies:



- [Node.js](https://nodejs.org/)

- [Gulp.js](https://gulpjs.com/)



### Quick Start



To work with this build, clone the entire contents of the repository using:



`git clone `



After cloning, navigate to the main project folder and run the following command to install all necessary dependencies specified in the package.json file:



```shell

npm install

```



Once the dependencies are installed, you can use any of the available build commands. The resulting files will be placed in the `app` folder in the root directory:



 ```shell

  npm run dev

``` 

The base command that starts the build process for development.



 ```shell

  npm run build

``` 

 Builds the project, optimizing and compressing all files for hosting.



 ```shell

  npm run cache

``` 

Run this command after gulp build if you need to upload new files to the hosting without using caching.



 ```shell

  npm run backend

``` 

Builds the backend part of the project. This build contains only the necessary elements and is not compressed, making it convenient for backend development.



 ```shell

  npm run zip

``` 

Packs your finished code into a zip archive.



 ```shell

  npm run deploy

``` 

Creates a temporary clone of the current repository, generates a gh-pages branch if it doesn't already exist, copies all files from the base path (or those matching patterns from the optional src configuration), commits all changes, and pushes to the origin remote.



`By following these steps, you'll be set up to work with the project efficiently.`



### 📝 Folder and file structure

```

├── gulp/                                     # All Gulp build settings, divided into separate files

├── src/                                      # Sources

│   ├── js                                    # Scripts

│   │   └── main.js                           # Main script

│   │   ├── _components.js                    # component connection file

│   │   ├── components                        # js components

│   │   ├── _functions.js                     # File with ready-to-use js functions

│   ├── styles                                # Main styles folder

│   │   └── main.scss                         # Main style file

│   │   └── vendor.scss                       # File for connecting library styles from the vendor folder

│   │   └── _fonts.scss                       # File for connecting fonts (you can use myxin)

│   │   └── _mixins.scss                      # File for connecting mixins from the mixins folder

│   │   └── _vars.scss                        # File for writing css or scss variables

│   │   └── _base-variables.scss              # File with global variables

│   │   └── _colors-variables.scss            # File with color variables

│   │   └── _offset-system-variables.scss     # File with offset system variables

│   │   └── _reset.scss                       # File with global tag reset

│   │   └── _settings.scss                    # File for writing global styles

│   │   └── _unitary-classes.scss             # File with unitary classes that are reused throughout the project

│   │   ├── components                        # scss components

│   │   ├── mixins                            # folder for saving finished mixins components

│   │   ├── vendor                            # folder for storing local css styles of libraries

│   ├── components                            # folder for storing html partials of the page

│   ├── pages                                 # folder for storing html pages of the project

│   ├── img                                   # folder for storing img

│   │   ├── svg                               # special folder for converting svg to sprite

│   ├── assets                                # folder for storing other assets - php, video files, favicon, etc.

│   │   ├── fonts                             # folder for storing fonts in woff2 format

│   └── index.html                            # Main html file

└── gulpfile.js                               # Gulp configuration file

└── package.json                              # file with build settings and installed packages

└── .editorconfig                             # file with code formatting settings

└── .ecrc                                     # editorconfig-checker package settings file (excludes unnecessary folders)

└── .prettierrc                               # Prettier settings file

└── README.md                                 # README build

```



### 📁 Working with html



Using **gulp-file-include**, you can divide an HTML file into various templates, which should be stored in the **components** folder.



---

> [!NOTE]

> **To insert HTML parts into the main file, use `@include('components/filename.html')**

---

When you run the `gulp build` command, all HTML files will be minified into a single line of code.



### 📁 Working with CSS



In build, the **sass** preprocessor in **scss** syntax is used.



Styles written in **components** should be plugged into **main.scss**.



To connect third-party css files (libraries) - put them in the **vendor** folder and connect them in the **\_vendor.scss** file.



In the final folder **app/css** two files are created:

- **main.css** - for page styles, 

- **vendor.css** - for styles of all libraries used in the project.



### 📁 Working with JavaScript



Webpack is used to build the JS code.



JS code is better divided into components - small js-files that contain their own, isolated from each other implementation. Place such files in the **components** folder, and then import them into the **\_components.js** file



The **main.js** file is the main file where all the others are connected.



### 📁 Working with fonts



The build implements support for **woff2** format only



Load the **woff2** files into the **assets/fonts** folder, and then call the `@font-face` mixin in the **\_fonts.scss** file.



Also, don't forget to put the same fonts in `` in the html.



### 📁 Working with images



Put any images other than **favicon** in the **img** folder.



If you need to make an svg sprite, put the svg files needed for the sprite in the **img/svg** folder. At the same time, attributes like fill, stroke, style will be automatically removed. Other svg files just leave them in the **img** folder.



If you use the `gulp build` command, you will get minified images in the final **img** folder.



### 📁 Working with other assets



Any project assets that do not have a corresponding folder should be stored in the **resources** folder. These can be video files, php files (such as form submission file), favicon and others.



### 📁 Typographer



For the correct display of text on the page was connected plugin typographer, which will automatically add unbroken spaces and other characters, so that the text everywhere displayed according to all the rules of the language.



### 📁 Seo optimization



The main index.html lists a brief excerpt and descriptions of each meta tag