Portfolio one page template - ARCHIVED
Flat and responsive website template, designed and coded by Maxim Orlov.
Demo: http://website-templates.github.io/portfolio_one-page-template
Product mockup created with http://magicmockups.com/
Contents
Folder and file structure
./
├── .editorconfig
├── gulpfile.js
├── package.json
├── README.md
|
├── gulp_tasks/ * gulp tasks
| ├── config/ * gulp tasks config
│ | ├── paths.js
│ | └── aliases.js
│ |
| └── task.js
|
├── screenshots/ * responsive test screenshots
|
├── dev/ * site source
│ ├── images/ * image sources
| │
│ ├── pug/ * templates
| | ├── blocks/ * blocks library
| │ | └── block.pug
| │ ├── helpers/ * helper mixins
| │ ├── vendor/ * third-party code
| │ ├── layouts/ * page layouts
| │ └── pages/ * main pages templates
| │
│ ├── js/ * source js
| | ├── vendor/ * vendor scripts library
| | ├── lib/ * site scripts library
| │ ├── head.js * head scripts
| │ └── body.js * body scripts
| │
| ├── sass/ * sass preprocessor styles
| | ├── blocks/ * blocks library
| │ | └── block.sass
| │ ├── helpers/ * mixins and vars
| │ ├── vendor/ * third-party code
| │ ├── custom.sass
| │ ├── noscript.sass
| │ └── screen.sass
| │
│ ├── helpers/ * helper files
| | ├── favicon.ico
| | └── .htaccess
| │
│ ├── fonts/ * font sources
| │
│ └── data/ * configs and data for templates
│
└── build/ * built source
├── index.html
├── page.html
|
└── static/ * static assets
├── css/ * minified styles
|
├── images/ * minified images
│
├── js/ * minified assembled js
|
└── fonts/ * @font-face-ready webfonts
Requirements
Editorconfig
This project has an .editorconfig file at the root. It describes indent style, trailing whitespaces etc. See more details here
How to start
If you haven't used Gulp before, be sure to check out the Getting Started guide, also check these recips
Before start you need to have installed npm , as well as gulp globally.
A few simple steps to start:
- Install dependencies from
package.jsonby running:npm install. - Run tasks from the list below and start devevelopment!
- Edit general settings in
dev/data/config.jsonSee Site configuration section
Site configuration
This boilerplate uses Pug templates with external data configs.
Main settings can be found in dev/data/config.json file. And they're available for usage in templates with config.key-name
Tasks
Here comes groups ofgulp tasks with some explanations
Cleanup
Remove placeholders from work directories.
Gulp: gulp cleanup
- Remove gitkeep files
Dev
Dev task with static server.
Gulp: gulp dev
- Bundle javascripts
- Compile Sass stylesheets
- Add vendor prefixes in css
- Combine media queries in css files
- Compile Pug templates
- Sync helpers and other assets
- Sync fonts
- Sync images
- Run BrowserSync static server with live reload using
- Watch for changes and run dev task
Build
Build task.
Gulp: gulp build
- Minify images
- Minify javascript files
- Minify stylesheets
- Minify html
- Run BrowserSync static server
Rebuild
Regenerate and build project by running all tasks.
Gulp: gulp rebuild
- Bundle javascripts
- Compile Sass stylesheets
- Add vendor prefixes in css
- Combine media queries in css files
- Compile Pug templates
- Sync helpers and other assets
- Sync fonts
- Sync images
- Minify images
- Minify javascript files
- Minify stylesheets
- Minify html
Server
Run server without watching for changes.
Gulp: gulp server
- Run BrowserSync static server
Live reload
This project uses BrowserSync as static server with enabled and configured live reload option.