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

https://github.com/autom8-apps/webpack-es6-typescript-boilerplate


https://github.com/autom8-apps/webpack-es6-typescript-boilerplate

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

# Webpack ES6 TypeSript Jest boilerplate

A dead simple webpack babel and jest build configuration to get and up and running with a new package, project, etc. in minutes!

## Prerequisites
1. `npm init` - to set up all of your package info of course! Make sure to rename the repository to your own.
2. in webpack.config.js make sure to rename the library name from `YOUR_LIBRARY_NAME` to whatever you would like.

## Features
- [Webpack](https://webpack.js.org/guides)
- [ECMAScript 6](http://es6-features.org)
- [TypeScript](https://www.typescriptlang.org/)
- [Babel](https://babeljs.io/docs/setup/#installation)
- [ESLint](https://eslint.org/docs/user-guide/getting-started)
- [Jest](https://facebook.github.io/jest/docs/en/getting-started.html)

## Installation

1. `git clone [email protected]:autom8-apps/webpack-es6-typescript-boilerplate.git`
2. Run `npm install`
3. Start the dev server using `npm run start`

## Commands
- `tsc`: compile typescript
- `build`: bundle code to dist,
- `start`: start the web dev server,
- `test`: run jest tests,
- `debug`: for debugger purposes, utilized in .vscode debugger launch config

## Licence
MIT.