https://github.com/willianjusten/fast-nunjucks
A simple boilerplate to create static sites using nunjucks templates, stylus and gulp to automate.
https://github.com/willianjusten/fast-nunjucks
Last synced: 3 months ago
JSON representation
A simple boilerplate to create static sites using nunjucks templates, stylus and gulp to automate.
- Host: GitHub
- URL: https://github.com/willianjusten/fast-nunjucks
- Owner: willianjusten
- Created: 2015-08-06T07:04:41.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-10-05T03:57:20.000Z (over 9 years ago)
- Last Synced: 2025-02-01T17:11:09.659Z (4 months ago)
- Language: CSS
- Size: 163 KB
- Stars: 28
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
---
A simple boilerplate to create projects with Nunjucks, Stylus, Gulp, Browser-sync and more.
Maybe you want to read about them:
- [GulpJS](http://gulpjs.com/)
- [Nunjucks](https://mozilla.github.io/nunjucks/)
- [Stylus](http://learnboost.github.io/stylus/)
- [Browser-sync](http://www.browsersync.io/)
For grid system I use [Jeet](http://jeet.gs/) with some help from [Kouto Swiss](http://kouto-swiss.io/) for animations, reset and a lot of great mixins. And for responsive utilities, [Rupture](https://github.com/jenius/rupture) is awesome =)
## Getting Started
### Installation
First of all, install the dependencies to run this boilerplate.
- [NodeJS](http://nodejs.org/)
- [GulpJS](http://gulpjs.com/)
```sh
# Clone this repository
$ git clone git://github.com/willianjusten/Fast-nunjucks.git new_project
$ cd new_project
# install dependencies
$ npm install
```
With the commands above, you have everything to start.
### Folders and Files
```sh
new_project -
/build -
/css
main.css
/img
/js
main.js
/src -
/img
/js
/styl
/templates
.editorconfig
.gitignore
Gulpfile.js
package.json
Readme.md
```
### Tasks
- `gulp`: Initialize watch for changes and a server(localhost:8080)
- `gulp js`: execute js files
- `gulp nunjucks`: compile nunjucks templates
- `gulp stylus`: compile stylus files
- `gulp imagemin`:compress image files
- `gulp watch`: call for watch files
- `gulp -p`: minify all files for production
### License
This boilerplate is free and open source software, distributed under the The MIT License. So feel free to use this to create your site without linking back to me or using a disclaimer.
If you’d like to give me credit somewhere on your blog or tweet a shout out to [@willian_justen](https://twitter.com/willian_justen), that would be pretty sweet.