This is my first open source project, that provides me help to build a static website organized, standardized web apps with quality and agility.
Make sure you have all these dependencies installed before moving on:
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 npm dependences:
$ npm install
4. Build project for development:
$ gulp
Now the local dev is running at localhost:8080 😄
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 npm install
command.
-
gulp
: run all tasks for development and initialize watch for changes and a server -
gulp -p
: run all tasks for production and initialize watch for changes and a server -
gulp nunjucks
: compile html files -
gulp javascript
: execute js files -
gulp stylus
: compile css files -
gulp images
: compress image files -
gulp watch
: call for watch files -
gulp browser-sync
: inicialize a server -
gulp deploy
: run all tasks and deploy files to gh-pages
-
npm run lint
: lint all files searching for errors, prepush and precommit. -
npm run lint:fix
: fix automaticaly some lint errors.
I will introduce some automated tests.
Feel free to contribute and improve the project. See CONTRIBUTING.md for more information and how to get started.
MIT License © Thalles Marchetti
Inspiration from some projects of my friend willian_justen