Skip to content

My front-end personal assistant, a webpack boilerplate for static websites.

License

Notifications You must be signed in to change notification settings

alexandonie/my-frontend-pa

Repository files navigation

My front-end PA logo

My front-end personal assistant

A webpack boilerplate for static websites that does: es6, sass, handlebars and more.
Visit the website »

License: MIT peerDependencies Status devDependency Status

Installation

Make sure nodejs and npm are installed on your machine. If not, follow these instructions and then proceed with the next steps:

git clone https://github.com/alexandonie/my-frontend-pa
cd my-frontend-pa
npm run install

There's no CLI setup wizard or anything like that so once you have everything on your machine, rename the project accordingly and run npm run start for the development mode or npm run build for the production mode.

Features

  • development server with live reloading and local access from any device (laptop, phone, etc)
  • es6 support
  • handlebars support
  • html, css and js transpilation, bundling and optimization
  • sass support
  • purgeCSS support to remove dead code
  • js linting
  • cache busting
  • clean urls (through automated folder structuring)

File structure

📦my-frontend-pa
 ┣ 📂config // this is where all the webpack config lives
 ┣ 📂dist // this is the auto-generated build folder
 ┃ ┣ 📂about
 ┃ ┣ 📂images
 ┃ ┣ 📜favicon.ico
 ┃ ┣ 📜index.html
 ┃ ┣ 📜main.54bbc493581d31e9c2b9.bundle.js
 ┃ ┗ 📜main.cd39ee536e4694328be3.css
 ┣ 📂src // this is where you'll write the actual code of your project
 ┃ ┣ 📂images
 ┃ ┣ 📂scripts
 ┃ ┣ 📂styles
 ┃ ┣ 📂views // every directory contains a few examples to get you going
 ┃ ┃ ┣ 📂includes
 ┃ ┃ ┃ ┣ 📜footer.hbs
 ┃ ┃ ┃ ┗ 📜header.hbs
 ┃ ┃ ┣ 📂layouts
 ┃ ┃ ┃ ┗ 📜base.hbs
 ┃ ┃ ┣ 📜index.hbs
 ┃ ┃ ┗ 📜page2.hbs
 ┃ ┣ 📜favicon.ico
 ┃ ┗ 📜index.js // the entry point of the app
 ┣ 📜.babelrc
 ┣ 📜.eslintrc
 ┣ 📜.gitignore
 ┣ 📜LICENSE
 ┣ 📜README.md
 ┣ 📜package-lock.json
 ┗ 📜package.json

FAQ

  1. How can I do inline background-image: url() using local images?

    Webpack won't be aware of the asset you're trying to load by using the normal syntax so you'll have to 'import' the image and then apply it as a background: style="background-image: url('${require('path/to/image')}');".

Author

Alex Andonie

License

The code is available under the MIT license.

Releases

No releases published

Packages

No packages published