https://github.com/mcnamee/frontend-boilerplate
A Starter Kit for Front-ends to build HTML pages
https://github.com/mcnamee/frontend-boilerplate
browsersync es6 frontend lint sass webpack
Last synced: 7 months ago
JSON representation
A Starter Kit for Front-ends to build HTML pages
- Host: GitHub
- URL: https://github.com/mcnamee/frontend-boilerplate
- Owner: mcnamee
- License: mit
- Created: 2016-06-04T06:53:10.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-06-09T23:21:44.000Z (almost 8 years ago)
- Last Synced: 2025-06-08T23:36:55.747Z (9 months ago)
- Topics: browsersync, es6, frontend, lint, sass, webpack
- Language: HTML
- Homepage:
- Size: 530 KB
- Stars: 13
- Watchers: 3
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Frontend Boilerplate
Starting a web project these days is time consuming. With all the build tools and package managers to configure, plus all of the generic code we need to include by default like a solid htaccess file - let's make it less daunting!
[Demo](http://mcnamee.github.io/frontend-boilerplate/)
### Tooling
- [Laravel Mix (Webpack)](https://github.com/JeffreyWay/laravel-mix)
- [SASS](http://sass-lang.com/)
- [Browser Sync](https://browsersync.io/)
### Frontend libraries
- [Bootstrap v4](http://getbootstrap.com/)
- [jQuery](https://jquery.com/)
### Code Styleguides
- [JavaScript](https://github.com/airbnb/javascript)
- [CSS/Sass](https://github.com/airbnb/css)
---
## Installing
```bash
# Clone the repo
git clone https://github.com/mcnamee/frontend-boilerplate.git
# Install dependencies
npm install
```
---
## Commands
| Command | Description |
| --- | --- |
| `npm run dev` | Compiles/copies assets to /dist |
| `npm run watch` | Watches your directory and compiles/copies assets to /dist each time you press save on a file |
| `npm run production` | Compiles/minifies/copies assets to /dist ready for production |
| `npm run lint-js` | Provides a report on your JS, against the code styleguide |
| `npm run deploy` | Deploys site to Github Pages |