Skip to content

Commit

Permalink
add readme, update package.json
Browse files Browse the repository at this point in the history
  • Loading branch information
Jimmydalecleveland committed Dec 28, 2020
1 parent ed398b8 commit f19cc54
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 9 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Webpack Starters for reference

A collection of different Webpack setups for quick referencing or starting from.

Each branch has a different setup for the named purpose, such as `typescript` showing a TypeScript variation.

_NOTE: Typically the `dist` or `public` folder is ignored in git, but for demonstrations purposes I've left it tracked._

## Start using for a new project, or playground

1. Clone the repo
2. Select the branch you want
3. Run `npm i` to install dependencies
4. Run one of the following commands, depending on intent:

### Production Build

```bash
npm run build
```

### Development Build

```bash
npm run build-dev
```

### Development Build, watching for file changes

```bash
npm run watch
```

### Development Server on port :8080

```bash
npm start
```
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 7 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
{
"name": "webpack-setup",
"name": "webpack-starters",
"version": "1.0.0",
"description": "",
"main": "index.js",
"private": true,
"description": "A collection of different Webpack setups for quick referencing or starting from",
"scripts": {
"start": "webpack serve",
"test": "echo \"Error: no test specified\" && exit 1",
"build": "NODE_ENV=production webpack --watch",
"build-dev": "webpack --watch"
"watch": "webpack --watch",
"build": "NODE_ENV=production webpack",
"build-dev": "webpack"
},
"keywords": [],
"author": "",
"author": "Jimmy DC",
"license": "ISC",
"devDependencies": {
"webpack": "^5.4.0",
Expand Down

0 comments on commit f19cc54

Please sign in to comment.