Skip to content

imbrn/es-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

es-boilerplate

The simplest useful EcmaScript 2015+ ready boilerplate. This boilerplate allows you to develop ES6+ projects using modules. It also supports CSS modules with PostCSS autoprefixer plugin.

Features

  • ES6+ modules;
  • CSS modules;
  • PostCSS ready;
  • Autoprefixer PostCSS plugin;
  • Webpack as module bundler;
  • Easy customization of environment with Webpack configuration files;
  • Npm and Yarn;
  • Webpack Development Server:
  • HOT Module Replacement;

How to use

Install

  1. To use this boilerplate as starting point of your project, first you need to clone this:
git clone https://github.com/bruno02221/es-boilerplate
  1. After that, you can modify its package.json file to include your application details, like version, name, repository etc. You should also rename its git remote origin to point to your project git repository.

  2. Then you're ready to start coding your application.

Folder structure

The application default folder structure can be used by your when developing your application without having to change it.

The default folder structure contains the following architecture:

  • config/ - This folder contains all the configuration files used by Webpack, developlment server, PostCSS etc. You can edit those files to customize your application behavior.

  • public/ - This folder contains an HTML file (index.html) which is the template of your application's main page. You can edit this file to custom it, add links to fonts, icons etc. You can also use this folder to include other statics files you need.

  • src/ - This folder contains application specific files like Javascript and CSS files. You should implement your application using files inside this folder. The default application bundler will use these to bundle your application.

Scripts

Installing project dependencies:

yarn install

or

npm install

Starting development server:

yarn start

or

npm start

Building app for production:

yarn build

or

npm install

License

MIT License

About

EcmaScript 6+ boilerplate with Webpack.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published