Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eluvade/hydra-boilerplate

Quickstart Boilerplate Template Project
https://github.com/eluvade/hydra-boilerplate

babel boilerplate boilerplate-template env es6 html-css-javascript javascript npm project-template webpack webpack-boilerplate webpack-configuration

Last synced: about 3 hours ago
JSON representation

Quickstart Boilerplate Template Project

Awesome Lists containing this project

README

        

[![npm version](https://img.shields.io/npm/v/hydra-boilerplate.svg?style=flat)](https://www.npmjs.com/package/hydra-boilerplate) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Eluvade/hydra-boilerplate/tree/2.0.1)

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

```shell
$ 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.