Simoneas02

My personal website.

Run the project local

0 - install the basic dependencies

• NodeJS
• GulpJS
• Bower

1 - Clone the project and install the dependencies:

$ git clone https://github.com/simoneas02/simoneas02.github.io.git
$ cd simoneas02.github.io/
$ npm install
$ bower install

2 - Run the local server:

$ gulp build
$ gulp server

Go to: localhost:8080

Stack

• Task Runner: Gulp
• HTML Template Engine: Pug
• CSS Preprocessor: Stylus
• JS Transpiler: Babel
• Package Manager: Bower
• Webcomponents: Polymer
• Bundler: Vulcanize

Folders Structure

.
├── out/
├── src/
|   ├── assets/
|   |   ├── img/
|   |   ├── scripts/
|   |   └── styles/
|   ├── includes/
|   |   ├──	custom-style.html
|   |   └── head-metas.pug
|   ├── layouts/
|   |   └── gothic.pug
|   └── index.pug
├── .babelrc
├──  bower.json
├── .editorconfig
├── .gitignore
├── .travis.yml
├── gulpfile.js
├── package.json
├── CONTRIBUTING.md
├── LICENSE.md
└── README.md

Automatic Tasks

• $ gulp build: Compile, concat and minify all files.
• $ gulp serve: Watch the files to build and start a static server.
• $ gulp stylint: Validate Stylus.
• $ gulp vulcanize: Concatenate a set of Web Components into one file.
• $ gulp deploy: Deploy.

Versioning

To keep better organization of releases we follow the Semantic Versioning 2.0.0 guidelines.

Contributing

Find on our issues the next steps of the project ;)
Want to contribute? Follow these recommendations.

License

MIT License © Simone Amorim