## :zap: Objective
This package has as objective emulate components of vtex to optimize or develop the local front-end.
Currently the package emulates the following components:
```html
```
### :x: Common mistakes.
Use the components underneath each other as the following example:
```html
```
**DO NOT** use the components together in line:
```html
```
## :rocket: Technologies
This project was developed with the following technologies:
---
- [Gulp](https://gulpjs.com/)
- [Gulp-util](https://www.npmjs.com/package/gulp-util)
- [Node](https://nodejs.org/en/)
- [Through2](https://www.npmjs.com/package/through2)
- [File System](https://nodejs.org/api/fs.html)
## :information_source: How To Use
To use this package you will need the [Gulp](https://gulpjs.com/) and [Node](https://nodejs.org/en/).
Starting from the structure:
```
Raiz da pasta
├---Templates
| | home.html
| |
| └--sub-templates
| footer.html
| header.html
|
├---Shelves
├---Banner & Html
|---gulpfile.js
```
On your command line:
```bash
# Install gulp-cli global
$ npm install --global gulp-cli
# Install gulp
$ npm install gulp
# Install sm-vtex-local
$ npm install sm-vtex-local
```
Create a gulpfile.js with these settings:
```js
const gulp = require('gulp');
const {templates, placeHolder} = require('sm-vtex-local');
gulp.task('components', ()=> {
gulp.src('./templates/*.html') // template path
.pipe(templates('./templates/sub-templates/')) // sub-template path
.pipe(placeHolder('./Shelves/', 5)) // Shelves path & number of items on the shelf
.pipe(placeHolder('./Banner & Html/')) // Banner & Html path
.pipe(gulp.dest('dist'));
})
```
Settings done, now just run:
```bash
$ gulp components
```
## :memo: License
This project is under the MIT license. See the [LICENSE](https://github.com/SamuelManoel/sm-vtex-local/blob/master/LICENCE) for more information.
---
Made with ♥ by Samuel Manoel Gomes
---
_Source: https://npm.io/package/sm-vtex-local · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
