https://github.com/richardevcom/frontend-boilerplate
Easy to use boilerplate for your front-end project.
https://github.com/richardevcom/frontend-boilerplate
Last synced: 4 months ago
JSON representation
Easy to use boilerplate for your front-end project.
- Host: GitHub
- URL: https://github.com/richardevcom/frontend-boilerplate
- Owner: richardevcom
- Created: 2020-04-29T11:04:26.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-02T00:19:18.000Z (over 4 years ago)
- Last Synced: 2025-01-05T17:13:30.182Z (6 months ago)
- Language: JavaScript
- Size: 98.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Front-end boilerplate (Gulp, Nunjucks, BrowserSync, SASS, SVG embed)
Easy to use boilerplate for your front-end project.
Boilerplate's main features:
- **Gulp** - *for automated tasks*
- **BrowserSync** - *for local development server*
- **Nunjucks** - *for templating (HTML)*
- **SVG embed** - *automated SVG conversion from `
` to ``*
## Install
Assuming that you have *Node.js* already installed follow these steps to install this repository on your machine:
1. `git clone https://github.com/richardevcom/front-end-boilerplate.git` - Clone this repository
2. `npm install` - Install node modules
2. **That's it.** If you like to change the directory names & locations, don't forget to change the paths in `./config.js` also.
## Run
- `npm run build` or `gulp build` - Build distribution files
- `npm run dev` or `gulp dev` - Run development environment & build on changes
- `npm run clean` or `gulp clean` - Clean distribution folder
*To use `gulp` commands, you have to `npm install --global gulp-cli`.*