View on GitHub

Marchetti_boilerplate

A simple boilerplate with ES6, Gulp, Stylus, Nunjucks and Browsersync.

Marchetti_boilerplate

Known Vulnerabilities devDependency Status PRs Welcome GitHub stars

This is my first open source project, that provides me help to build a static website organized, standardized web apps with quality and agility.

Requirements

Make sure you have all these dependencies installed before moving on:

Instructions

1. Clone the project:
$ git clone https://github.com/thallesmarchetti/marchetti-boilerplate.git

2. Change directory to the cloned folder:
$ cd marchetti-boilerplate

3. Install required dependences:
$ yarn

4. Build project for development:
$ gulp

Now the local dev is running at localhost:8080 :smile:

Structure

The basic structure of the project is given in the following way:

│
├── app/
│   │── images/
│   │── javascript/
│   │    ├── scripts.js
│   │── stylus/
│   │    ├── main.styl
│   │── views/
│   │    │── content/
│   │    │   ├── main.html
│   │    │── includes/
│   │    │   ├── footer.html
│   │    │   ├── head.html
│   │    │   ├── header.html
│   │    │── layout/
│   │    │   ├── layout.html
│   │    │
│   └── index.html
│
├── .editorconfig
├── .eslintrc
├── .gitignore
├── gulpfile.js
├── LICENSE.md
├── package.json
└── README.md

Dependencies

Building a project requires a few dependencies, they are needed only during development and should not be installed on production. They will be installed along with your project dependencies when running yarn command.

Tasks

Scripts

License

MIT License © Thalles Marchetti

Acknowledgments

Inspiration from some projects of my friend willian_justen