codelinered / gulp-skeleton
Skeleton to create templates with Gulp
Installs: 0
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 1
Forks: 2
Open Issues: 0
Language:HTML
Type:project
Requires
- php: >=5.5.9
This package is not auto-updated.
Last update: 2023-05-27 09:04:11 UTC
README
Table of contents
- Included Third Party Code
- Install Guides
- Project Commands
gulpfile.json- Localization
- Links
Included
Install Production Build (Recommended)
Required
- PHP >= 5.5
Open console on your OS and navigate to your project folder. Download zip if you don't have git on your OS.
+++++ ZIP VERSION +++++
$ (unix) wget -O gs-prod.zip https://github.com/CodelineRed/gulp-skeleton/archive/production.zip
$ (unix) unzip gs-prod.zip
$ (win10) curl -L -o gs-prod.zip https://github.com/CodelineRed/gulp-skeleton/archive/production.zip
$ (win10) tar -xf gs-prod.zip
$ cd gulp-skeleton-production
+++++ GIT VERSION +++++
$ git clone https://github.com/CodelineRed/gulp-skeleton.git
$ cd gulp-skeleton
$ git checkout production
$ (optional on unix) rm -rf .git
$ (optional on win10) rmdir .git /s
+++++ COMPOSER VERSION +++++ $ php composer create-project codelinered/gulp-skeleton gulp-skeleton "dev-production" $ cd gulp-skeleton
If you need PHP, you have to go to Install PHP.
Install Master/ Develop Build
Required
Open console on your OS and navigate to your project folder. Download zip if you don't have git on your OS.
+++++ ZIP VERSION +++++
$ (unix) wget -O gs-mstr.zip https://github.com/CodelineRed/gulp-skeleton/archive/master.zip
$ (unix) unzip gs-mstr.zip
$ (win10) curl -L -o gs-mstr.zip https://github.com/CodelineRed/gulp-skeleton/archive/master.zip
$ (win10) tar -xf gs-mstr.zip
$ cd gulp-skeleton-master
$ npm i
$ gulp build
$ gulp
+++++ GIT VERSION +++++
$ git clone https://github.com/CodelineRed/gulp-skeleton.git
$ cd gulp-skeleton
$ git checkout master
$ (optional on unix) rm -rf .git
$ (optional on win10) rmdir .git /s
$ npm i
$ gulp build
$ gulp
+++++ COMPOSER VERSION +++++
$ php composer create-project codelinered/gulp-skeleton
$ cd gulp-skeleton
$ npm i
$ gulp build
$ gulp
Open localhost:3000 for Website.
Install PHP (optional)
Required
Open console on your OS and navigate to the unziped/ cloned app folder.
$ (unix) systemctl docker start
$ (windows) "c:\path\to\Docker Desktop.exe"
$ docker-compose up -d
Open localhost:7701 for Website.
Project Commands
| Description | |
|---|---|
| gulp | watch files and start BrowserSync |
| gulp build | executes following tasks: cleanUp, favicon, font, img, js, jsLint, scss, scssLint, svg |
| gulp lintAll | executes following tasks: jsLint, scssLint |
| gulp cleanUp | clean up public folder |
| gulp favicon | generate favicons |
| gulp font | copy font files |
| gulp img | copy and compress images |
| gulp js | uglify, minify and concat js files |
| gulp jsLint | checks js follows lint rules |
| gulp scss | compile, minify and concat scss files |
| gulp scssLint | checks scss follows lint rules |
| gulp thankYou | a small thank for you |
| gulp svg | copy and compress svg files |
| gulp watch | watch favicon, font, img, js, scss and svg files |
gulpfile.json
| Description | |
|---|---|
| browserSyncConfig | Required - Defines which config is used for BrowserSync (default: browserSyncDocker) |
| sourcePath | Required - Path to raw files (default: src/) |
| publicPath | Required - Path to transpiled files (default: public/) |
| systemPath | Optional - Alternative Path to transpiled files on CMS, ECS, PHP Framework, ... (default: path/to/system/) |
| env | Required - Environment dev, test or prod (default: dev) |