https://github.com/sethbergman/webcomponents-webpack-es6
https://github.com/sethbergman/webcomponents-webpack-es6
es6 starter-kit webcomponents webpack workbox
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sethbergman/webcomponents-webpack-es6
- Owner: sethbergman
- License: mit
- Created: 2017-05-26T02:52:13.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-03-23T05:05:47.000Z (over 8 years ago)
- Last Synced: 2025-08-09T18:59:31.495Z (11 months ago)
- Topics: es6, starter-kit, webcomponents, webpack, workbox
- Language: JavaScript
- Size: 147 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# [Web Components](https://www.webcomponents.org/) project starter using ES6 and [Webpack](https://webpack.github.io/)
[](https://travis-ci.org/sethbergman/webcomponents-webpack-es6)
[](https://codecov.io/gh/sethbergman/webcomponents-webpack-es6)
[](LICENSE.txt)
## Project setup includes:
- [x] [web-component](https://github.com/sethbergman/webcomponents-webpack-es6)
- [x] Server Rendering
- [x] Webpack2
- [x] Webpack Dashboard
- [x] Dev Middleware
- [x] Web Components es5 shim
- [x] Babel 6
- [x] Boostrap
- [x] Font Awsome
- [x] Eslint
- [x] Jest
## TODO
- [ ] Uglify on production (doesn't work with es6 browsers)
- [ ] Fix jest tests - html templates, mock customElements
## Installation
```sh
$ git clone https://github.com/sethbergman/webcomponents-webpack-es6.git app-name
$ cd app-name
$ npm install
```
## Development
- Build once for (ready for **_Production_**):
- `$ npm run build`
- `$ npm run build:serve`
The last command will boot up HTTP server on `3003` port and serve `build/client` directory in a default browser
- Hot reloading via webpack middlewares:
- `$ npm start`
- Point your browser to , page hot reloads automatically when there are changes
## Testing
To execute all unit tests, use:
```sh
$ npm run test
```
To run unit tests continuously during development (watch tests), use:
```sh
$ npm run test:watch
```
## Expose App on Your Local Dev Machine
Assign yourself a unique publicly accessible url that will proxy all requests to your locally running webserver.
```sh
$ npm install -g localtunnel
$ npm start
$ npm run tunnel # run in a new tab
```
You will receive a url, for example `https://tbst.localtunnel.me`, that you can share with anyone for as long as your local instance of `lt` remains active. Any requests will be routed to your local service at the specified port.
## License
The code is available under the [MIT license](LICENSE.txt).