Template to start from before starting frontend projects.
- Create empty repository for your project. learn how need a link here
- Clone boilerplate into project directory and navigate there.
$ git clone https://github.com/mate-academy/gulp-template.git project-name
$ cd project-name
- Change remote repository to recently created
$ git remote set-url origin github-link-of-project
- Install dependencies
$ npm install
All packages will be installed after executing the script above.
$ npm run start
$ npm run build
To check codestyle manually execute command:
$ npm run lint
This command will check codestyle for html/scss/js files in /src
. Also,
linters run on pre-commit
hook and during development.
- Follow the simplified JS styleguide
- Follow HTML, CSS styleguide
- Build the project
$ npm run build
- Commit and push all recent changes
$ git add .
$ git commit -m 'commit message'
$ git push origin branch-name
- Execute
npm run deploy
. This command will push the/dist
folder to branchgh-pages
in your remote repository. - Enable
gh-pages
for your repository. learn how need a link here
src/
- directory for html, css, sass, js, image, fonts filesdist/
- directory for built pages
You should be writing code in src/
directory.
Task $ npm run start
When task is executed, gulp starts local web server BrowserSync and opens index.html.
Server uses dist/
as a project root.