https://github.com/florianporada/another-webpack-boilerplate

Another webpack boilerplate
https://github.com/florianporada/another-webpack-boilerplate

Last synced: 1 day ago
JSON representation

Another webpack boilerplate

• Host: GitHub
• URL: https://github.com/florianporada/another-webpack-boilerplate
• Owner: florianporada
• License: mit
• Created: 2021-01-22T09:23:34.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-04-01T20:07:16.000Z (almost 2 years ago)
• Last Synced: 2024-11-30T07:31:49.110Z (2 months ago)
• Language: JavaScript
• Size: 561 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Another Webpack Boilerplate

![Build](https://github.com/florianporada/another-webpack-boilerplate/workflows/Build%20And%20Deploy/badge.svg)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/florianporada/another-webpack-boilerplate/issues)

## Usage

1. `git clone https://github.com/florianporada/another-webpack-boilerplate.git `

2. `cd `

3. `yarn run new`

4. `yarn start`

### Quickstart

```bash

export PROJECT_NAME=superservice

git clone https://github.com/florianporada/another-webpack-boilerplate.git $PROJECT_NAME

cd $PROJECT_NAME

rm -rf .git

echo $PROJECT_NAME > README.md

git init -b main

git add .

git commit -m "chore: add boilerplate code"

echo "READY TO GO"

```

## Features

- Webpack 5

- Tailwind 3 support

- ES6 transpiling

- Automatic favicon generation

- Docker ready

  ...

### Feature explanations

Since this boilerplate is basically a port of [tris-webpack-boilerplate](https://github.com/tr1s/tris-webpack-boilerplate) to webpack 5 with some new features, most of the features are explained [here](https://github.com/tr1s/tris-webpack-boilerplate#features-explained).

---

## Deployment

The standard behavior of the action is to create a docker image and push it to the docker registry.

- GitHub Actions Environment Secrets

  ```txt

  DOCKER_USERNAME

  DOCKER_PASSWORD

  ```

- Skip CI:

  If the commit message contains `skip ci` the GitHub Action will not be triggered.

## Credits

- Heavily inspired by: [tris-webpack-boilerplate](https://github.com/tr1s/tris-webpack-boilerplate)