https://github.com/codeandwander/boilerplate
A boilerplate for developing basic websites, i.e HTML, SCSS and JavaScript.
https://github.com/codeandwander/boilerplate
Last synced: 2 months ago
JSON representation
A boilerplate for developing basic websites, i.e HTML, SCSS and JavaScript.
- Host: GitHub
- URL: https://github.com/codeandwander/boilerplate
- Owner: codeandwander
- Created: 2017-05-30T11:01:00.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-09-08T09:47:41.000Z (over 7 years ago)
- Last Synced: 2025-01-24T12:45:40.697Z (4 months ago)
- Language: JavaScript
- Homepage: http://codeandwander.com
- Size: 1.37 MB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Boilerplate
A boilerplate for developing basic websites, i.e HTML, SCSS and JavaScript.
## What's included
* Webpack
* Webpack Dev Server
* Style, CSS, SCSS and font loaders - autoprefixer, eslint
* Production builder, minifies everything
## Installation
```bash
$ git clone https://github.com/codeandwander/boilerplate.git
$ cd boilerplate
$ yarn/npm install
```
## To run in development
```bash
$ npm run dev
```
## To deploy
```bash
$ npm run deploy
$ //push/upload to hosting provider
$
$ npm run start-production //for testing production locally
```
## Staging env
```bash
$ npm run deploy
$ npm run start-staging
```
## Application Structure
Work from the assets folder and stay our of the local and production build folders
```
.
├── assets # Main assets folder
│ ├── fonts # Put all fonts in'ere
│ ├── html # Main index.html template is inside
│ ├── img # Put all images in here
│ ├── js # Put all your JavaScript in here
│ ├── scss # Put all your SCSS in here
├── local # A compiled environment used for development
├── production # A compiled environment used for production
├── eslintrc.json # Keeping JS neat & tidy
├── .gitignore # Ignore various stuffz
├── package.json # Dependancies and bits
├── README.md # This very file 👀
├── server.js # For serving up our delicious local and production enviroments
├── webpack.local.config.js # Handles building local enviroment
├── webpack.production.config.js # Handles building production enviroment
├── yarn.lock # Some yarn thing...
```