Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/king-prawns/webpack5-starter-kit

Webpack 5 starter kit
https://github.com/king-prawns/webpack5-starter-kit

babel flow webcomponents webpack-dev-server webpack5

Last synced: 1 day ago
JSON representation

Webpack 5 starter kit

Awesome Lists containing this project

README

        

# webpack5-starter-kit

Webpack 5 with webpack-dev-server configuration (and Web Components).

## Dependencies

- Node v14.18.0 (or later)
- Yarn v1.22 (or later) | NPM v6.13.4 (or later)

## Installation via CLI

* Install w5kit-cli

```
npm install -g w5kit-cli
```

* Launch the CLI

```
w5kit
```

* Choose `Vanilla JS`

## Installation via Clone

* Clone this repository

```
git clone https://github.com/king-prawns/webpack5-starter-kit.git [your-app-name]
```

Remove the .git folder and change details within:

```
package.json
src/manifest.json
```

* Install dependencies

```
$ cd your-app-name
$ yarn
```

## Available tasks

```sh

# Runs development server (Webpack dev server)
$ yarn dev

# Build command
$ yarn build

# Lint with ESLint
$ yarn lint

# Run Flow
$ yarn flow

# Run unit tests (ava + instanbul)
$ yarn test

# Runs http-server on port 8082
$ yarn httpserver

```

## Features

* [Webpack 5](https://github.com/webpack/webpack)
* [Flow](https://flow.org/)
* [EsLint](https://eslint.org/docs/user-guide/getting-started)
* [StyleLint](https://github.com/stylelint/stylelint)
* [Postcss](https://github.com/postcss/postcss)
* [Jest](https://github.com/facebook/jest)
* [Web Components](https://developer.mozilla.org/en-US/docs/Web/Web_Components)

## TypeScript

### Please go to [TS repo](https://github.com/king-prawns/webpack5-starter-kit-ts)