codelinered / vue-skeleton
Vue.js Skeleton with Gulp
Installs: 1
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Language:JavaScript
Type:project
Requires
- php: >=5.5.9
This package is not auto-updated.
Last update: 2023-12-04 18:58:23 UTC
README
Table of contents
- Included Third Party Code
- Install Guides
- Project Commands
gulpfile.json- Localization
- Links
Included
- jQuery 3
- Bootstrap 5
- Font Awesome 6
- Slick Carousel 1
- LazyLoad 17
- CSS User Agent 2
- Cookieconsent 3
- Vue 3
- Vue Router 4
- Vue i18n 9
- Vue SFC 1
Install Production Build (Recommended)
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 vs-prod.zip https://github.com/CodelineRed/vue-skeleton/archive/production.zip $ (unix) unzip vs-prod.zip $ (win10) curl -L -o vs-prod.zip https://github.com/CodelineRed/vue-skeleton/archive/production.zip $ (win10) tar -xf vs-prod.zip
+++++ GIT VERSION +++++
$ git clone https://github.com/CodelineRed/vue-skeleton.git
$ cd vue-skeleton
$ git checkout production
$ (optional on unix) rm -rf .git
$ (optional on win10) rmdir .git /s
+++++ COMPOSER VERSION +++++ $ php composer create-project codelinered/vue-skeleton vue-skeleton "dev-production" $ cd vue-skeleton
If you need PHP, you have to go to Install PHP.
Install Master/ Develop Build
Required
- Node.js >= 16
- npm
$ npm i npm@latest -g - gulp-cli
$ npm i gulp-cli@latest -g windows-build-tools$ npm i windows-build-tools@latest -g
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 vs-mstr.zip https://github.com/CodelineRed/vue-skeleton/archive/master.zip
$ (unix) unzip vs-mstr.zip
$ (win10) curl -L -o vs-mstr.zip https://github.com/CodelineRed/vue-skeleton/archive/master.zip
$ (win10) tar -xf vs-mstr.zip
$ cd vue-skeleton-master
$ npm i
$ gulp build
$ gulp
+++++ GIT VERSION +++++
$ git clone https://github.com/CodelineRed/vue-skeleton.git
$ cd vue-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/vue-skeleton
$ cd vue-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:7702 for Website.
Project Commands
| Description | |
|---|---|
| gulp | watch files and start BrowserSync |
| gulp build | executes following tasks: cleanUp, favicon, font, img, js, jsLint, jsRequire, jsRequireSAR, json, scss, scssLint, svg, vue, vueJs, vueJsLint, vueLint |
| gulp lintAll | executes following tasks: jsLint, scssLint, vueJsLint, vueLint |
| 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 jsRequire | copy, uglify and rename files for requirejs |
| gulp jsRequireSAR | search and replace text in third party files (use this after every gulp jsRequire) |
| gulp json | copy and minify json files |
| gulp scss | compile, minify and concat scss files |
| gulp scssLint | checks scss follows lint rules |
| gulp svg | copy and compress svg files |
| gulp thankYou | a small thank for you |
| gulp vue | transpile vue files |
| gulp vueJs | transpile vue js files |
| gulp vueJsLint | checks vue js follows lint rules |
| gulp vueLint | checks vue follows lint rules |
| gulp watch | watch scss, js, json, vue, img, font and svg files |
Localization
gulpfile.json
| Description | |
|---|---|
| browserSyncConfig | Required - Defines which config is used for BrowserSync (default: browserSyncDev) |
| 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) |