https://github.com/katallaxie/vue-preboot
:neckbeard: A teeny Vue.js + TypeScript boilerplate with SSR :thumbsup:. It is opinionated and powered by Webpack.
https://github.com/katallaxie/vue-preboot
jest pwa typscript vue vue-preboot webpack
Last synced: about 1 year ago
JSON representation
:neckbeard: A teeny Vue.js + TypeScript boilerplate with SSR :thumbsup:. It is opinionated and powered by Webpack.
- Host: GitHub
- URL: https://github.com/katallaxie/vue-preboot
- Owner: katallaxie
- License: mit
- Created: 2017-11-08T06:33:56.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-06-02T00:31:23.000Z (almost 6 years ago)
- Last Synced: 2025-03-25T08:03:41.002Z (about 1 year ago)
- Topics: jest, pwa, typscript, vue, vue-preboot, webpack
- Language: TypeScript
- Homepage:
- Size: 3.69 MB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vue Preboot
[](https://twitter.com/SwiftOnSecurity)
[](https://github.com/auchenberg/volkswagen)
[](https://travis-ci.org/katallaxie/vue-preboot)
[](http://opensource.org/licenses/MIT)
[](https://greenkeeper.io/)
> A [Vue](https://vuejs.org/) boilerplate, which has a lot of features and is driven by great spirit.
# Features
> The boilerplate is opinionated, and nudges devs to do certain things
- [Fluffy](https://github.com/andersnormal/fluffy) ([SSR](https://ssr.vuejs.org) + Hot Module Reload)
- [Webpack](http://webpack.github.io/) :heartbeat: `4.0.0`
- [TypeScript](http://www.typescriptlang.org/)
- [@types](https://www.google.com/url?sa=t&rct=j&q=&esrc=s&source=web&cd=3&cad=rja&uact=8&ved=0ahUKEwjgjdrR7u_NAhUQ7GMKHXgpC4EQFggnMAI&url=https%3A%2F%2Fwww.npmjs.com%2F~types&usg=AFQjCNG2PFhwEo88JKo12mrw_4d0w1oNiA&sig2=N69zbO0yN8ET7v4KVCUOKA)
- [TsLint](http://palantir.github.io/tslint/)
- [PostCss](https://github.com/postcss/postcss) + [Autoprefixer](https://github.com/postcss/autoprefixer)
- [Jest](https://facebook.github.io/jest)
- [Docker](https://docker.io)
- [Prettier](https://github.com/prettier/prettier)
- [Puppeteer](https://github.com/GoogleChrome/puppeteer)
- [TypeStyle](https://github.com/typestyle/typestyle)
- [Vuex](https://github.com/vuejs/vuex)
- [Vue.js Router](https://github.com/vuejs/vue-router)
- [Element](https://element.eleme.io/)
- Offline Support (PWA)
## Quick Start
> We support Node.js `>= 6.9.1`, NPM `>= 3.x` [Yarn](https://yarnpkg.com)
> If you downgrade to `protractor@4.9.x` you could run the boilerplate in Node `> 4.7.x`
> We recommend and support [Visual Studio Code](https://code.visualstudio.com/)
> We recommend to use [NVM](https://github.com/creationix/nvm) to manage your Node.js version and dependencies
> We highly recommend to use
```
# clone the repo
# --depth 1 removes all but one .git commit history
git clone --depth 1 https://github.com/katallaxie/vue-preboot.git
# change to repo folder
cd vue-preboot
# install the repo with npm, or yarn
npm install
# start the webpack-dev-server
npm start
# if you're in China use cnpm
# https://github.com/cnpm/cnpm
```
> You can run `npm run help` to see all available scripts
Open [http://0.0.0.0:3000](http://0.0.0.0:3000) or [http://localhost:3000](http://localhost:3000) in your favorite Browser.
### Build and run the SSR
```bash
# builds the prod version of the client and the needed SSR bundle
npm run build:docker
# runs the server `npm run server`
docker run -p 8080:80 -t vue-preboot
```
### Testing is import for quality products
> We have [Jest](https://facebook.github.io/jest) and [Protractor](http://www.protractortest.org/) in place
```bash
# run your unit tests
npm run tests
# or develop with unit tests in the loop
npm run watch:test
```
# License
[MIT](/LICENSE)