https://github.com/vardius/web-components-webpack-es6-boilerplate
Web Components project starter using ES6 and Webpack
https://github.com/vardius/web-components-webpack-es6-boilerplate
boilerplate bootstrap es6 web-components webcomponents webpack webpack2
Last synced: about 1 year ago
JSON representation
Web Components project starter using ES6 and Webpack
- Host: GitHub
- URL: https://github.com/vardius/web-components-webpack-es6-boilerplate
- Owner: vardius
- License: mit
- Created: 2017-05-05T22:52:24.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T01:01:14.000Z (over 3 years ago)
- Last Synced: 2024-10-14T06:09:19.059Z (over 1 year ago)
- Topics: boilerplate, bootstrap, es6, web-components, webcomponents, webpack, webpack2
- Language: JavaScript
- Size: 1.53 MB
- Stars: 43
- Watchers: 5
- Forks: 14
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- 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/vardius/web-components-webpack-es6-boilerplate)
[](https://codecov.io/gh/vardius/web-components-webpack-es6-boilerplate)
[](LICENSE.txt)
## Project setup includes:
- [x] [web-component](https://github.com/vardius/web-component)
- [x] Server Rendering
- [x] Webpack
- [x] Webpack Dashboard
- [x] Dev Middleware
- [x] Web Components
- [x] Babel
- [x] Boostrap
- [x] Font Awsome
- [x] Eslint
- [x] Jest
## Installation
```sh
$ git clone https://github.com/vardius/web-components-webpack-es6-boilerplate 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 http://localhost:3000/, 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).