README.md

Welcome to Modern JS Boilerplate

A simple js module boilerplate with all modern technologies

Table of contents
Features
Usage
📜 Documentation Build for development Build for production Cleaning Linting Prettifying Testing
Stack
👨‍💻 Developer
For all Developers
🤝 Contributing
🤝 Contributors
Show your support
📝 License

Features

• Modern
• Simple
• Supports ES6
• Advanced Optimizations
• Powerful git hooks and automated tasks
• Highly extensible
• Suitable for all
• Out of the box tree-shaking
• Minifies, compresses and mangles the production build

Usage

• You need to have a machine installed with git and node (which has npm included within it) use this boilerplate

git clone https://github.com/Rajaniraiyn/modern-js-boilerplate.git

cd modern-js-boilerplate

npm install

📜 Documentation

Build for development

• Starts a local server at https://localhost:8080 with HMR(Hot-Module-Replacement) using webpack-dev-server with babel

npm run dev

Build for production

• Creates a minified and optimized code for production in dist folder using webpack with babel and terser

npm run build

Cleaning

• Removes all files in dist folder using rimraf

npm run clean

Linting

• Lints all files in src directory using ESLint with Airbnb style

npm run lint

Prettifying

• Lints the code then prettify the code using prettier

npm run prettier

Testing

• Tests according my.test.js using jest

npm run test

Stack

ES Lint	Babel	jest	Prettier	Terser	Webpack	Husky

👨‍💻 Developer

Rajaniraiyn

• Website: https://rajaniraiyn.github.io/
• Github: @rajaniraiyn
• LinkedIn: @rajaniraiyn

For all Developers

If you optimize everything, you will always be unhappy. - Donald Knuth

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page. You can also take a look at the contributing guide.

🤝 Contributors

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2021 Rajaniraiyn.

This project is MIT licensed.

---