https://github.com/patrickfrank1/express-webpack-boilerplate
Boilerplate for development environment with express, webpack, babel, eslint, jsdoc, jest and scss
https://github.com/patrickfrank1/express-webpack-boilerplate
boilerplate-webpack node-boilerplate webpack4-boilerplate
Last synced: 5 months ago
JSON representation
Boilerplate for development environment with express, webpack, babel, eslint, jsdoc, jest and scss
- Host: GitHub
- URL: https://github.com/patrickfrank1/express-webpack-boilerplate
- Owner: patrickfrank1
- Created: 2020-02-21T17:45:39.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-02T04:59:39.000Z (over 2 years ago)
- Last Synced: 2023-03-05T18:53:27.902Z (about 2 years ago)
- Topics: boilerplate-webpack, node-boilerplate, webpack4-boilerplate
- Language: JavaScript
- Homepage:
- Size: 7 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# express-webpack-babel-eslint-jsdoc-jest-scss
Boilerplate for development environment with express, webpack, babel, eslint, jsdoc jest and scss.
See it live at https://express-webpack-boilerplate.herokuapp.com/.
## Install
1. Clone the repo
``` bash
git clone [email protected]:patrickfrank1/express-webpack-babel-eslint-jest-scss.git
cd express-webpack-babel-eslint-jest-scss
```
2. Install dependencies from package.json
``` bash
npm i
```
3a. Run development server
``` bash
npm run build:dev
```
3b. Serve with express server in production
``` bash
npm run build:prod
npm run start
```
## Configuration
Directories:
- src: contains all the source files, subfolders for js, css, img and external ressources
- test: files to test your code
- dist: production files served with server.js in root directory
- documentation: jsdoc files reside in this directory
- coverage: as constructed by jest
ESLint:
- extends airbnb style guide
Webpack:
- copy external files with CopyWebpackPlugin
- create index.html from template
- minify with terser
- transpile js with @babel/preset-env
- transpile scss
- bundle images
- use 'externals' key to make webpack aware of external libraries