- [TSlint](https://github.com/palantir/tslint) TypeScript Linter configured with the [Standard](https://github.com/standard/standard) JavaScript Code Style
- Testing Suite using [Jest](https://github.com/facebook/jest) (See `Testing` section)
- Configurable CI Pipeline using [CircleCI](https://circleci.com/) & [Codecov](https://codecov.io) (See `CI Pipeline` section)
## Installation 🔧
**System prerequisites :**
- Pretested on Windows, Mac & Linux
- Node.js 8 LTS or 10 latest
- yarn > 1.9 (no guarantees if you prefer to use npm)
Clone this repository :
```bash
$ git clone git@github.com:kevinmarrec/quasar-typescript example
$ cd example
$ yarn
```
## Usage
```bash
$ yarn dev # Start a SPA server
$ yarn dev:ssr # Start a SSR + PWA server
```
## Testing (WIP)
## CI Pipeline (WIP)
## Building
You can build your application for production using :
```bash
$ yarn build # Build your SPA (it places the artifacts at /dist/spa-mat)
$ yarn build:ssr # Build your SSR + PWA (it places the artifacts at /dist/ssr-mat)
```
If you want then to clean build artifacts, just do :
```bash
$ yarn build:clean
```
## Serving
You can serve your production ready application locally using :
```bash
$ yarn serve # Serve your SPA
$ yarn serve:ssr # Serve your SSR + PWA
```
By default, SPA and SSR apps are respectively served on ports `4000` and `3000`
You can override the port using an environment variable :
```bash
$ PORT=3210 yarn serve # Serve your SPA on port 3210
$ PORT=3210 yarn serve:ssr # Serve your SSR + PWA on port 3210
```
## Deploy with Now.sh
Deploying with [Now](https://zeit.co/now) is a breeze. The Now CLI is already shipped in the starter kit development dependencies so all you need to do is :
```bash
$ yarn deploy # Deploy your SPA on Now.sh
$ yarn deploy:ssr # Deploy your SSR + PWA on Now.sh
```
> You might want to use a "now alias" or connect your domain to Now - or even look into automatic deployment with [their Github integration](https://zeit.co/blog/now-for-github).
`Now.sh` will install the dependencies automatically then run `$ yarn start`. Your website will be up and running on an HTTPS connection in a matter of seconds !
