Skip to content

Eluvade/hydra-boilerplate

Repository files navigation

npm version GitHub license

Hydra - Boilerplate Webpack 5 Template Project

Quick start your project with Webpack 5 + Babel + Typescript + Stylers fully configured


List of features

  • Robust Webpack Configuration File for both production and development environments
  • Babel Transpiler
  • TypeScript Transpiler
  • scss/sass/less Transpilers
  • Minimizers, linters, terser, chunking, asset & build optimization

External links -> Documentation and Github repositories

Link to your webpacks' official github & documentation

Link to your babels' official github & documentation

Installation

$ git clone https://github.com/Eluvade/hydra-boilerplate.git
$ cd hydra-boilerplate
$ npm ci

Contributing

Keeping it simple and lightweight is the number 1 priority. Don't add unnecessary libraries just because you can.

Usage

npm run build : Compiles /src folder and creates /dist folder in the projects' root
npm run start : Launches webpack-dev-server with Hot Module Replacement - http://localhost:8080 by default

Note: /src is a mockup folder. You're free to delete and re-write all data inside, but keep the folder structure intact if you don't want to re-configure webpack

In order for Webpack to bundle your image/gif/video/music assets, you need to import/require them in your javascript. URL's in CSS will be resolved automatically.

Known Issues

On Linux: If building gives you an Error: "Cannot find module node-sass", try the following: ```shell $ sudo npm install --save-dev --unsafe-perm node-sass ```

Author

  • Bunny Eluvade

License

This project is licensed under the MIT License.