Skip to content

Commit 41160c8

Browse files
Merge branch 'release/v0.1.2'
2 parents f37384d + 07371aa commit 41160c8

File tree

4 files changed

+126
-15
lines changed

4 files changed

+126
-15
lines changed

.env

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
VUE_APP_PACKAGE_JSON=''
33

44
# TAG must be corresponding with the version tag in package.json, need to modify it when new version releases
5-
TAG=0.1.1
5+
TAG=0.1.2

CHANGELOG.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
## [0.1.2](https://github.com/johnnymillergh/vuetify-typescript-playground/compare/v0.1.1...v0.1.2) (2019-12-30)
2+
3+
4+
### Documentation
5+
6+
* **$README:** update README.md ([1af96fb](https://github.com/johnnymillergh/vuetify-typescript-playground/commit/1af96fbfc29be5aa9f7cde699fa40a3d5a31548a))
7+
8+
9+
### BREAKING CHANGES
10+
11+
* **$README:** update README.md
12+
13+
14+
115
## [0.1.1](https://github.com/johnnymillergh/vuetify-typescript-playground/compare/v0.1.0...v0.1.1) (2019-12-27)
216

317

README.md

Lines changed: 110 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,126 @@
1-
# vuetify-typescript-playground
1+
![TypeScript Playground Feature Graphics](https://raw.githubusercontent.com/johnnymillergh/MaterialLibrary/master/vuetiify-typescript-playground/vuetify-typescript-playground-blue-background.png)
22

3-
## Project setup
4-
```
5-
npm install
6-
```
3+
[![GitHub release](https://img.shields.io/github/release/johnnymillergh/vuetify-typescript-playground.svg)](https://github.com/johnnymillergh/vuetiify-typescript-playground/releases)
4+
[![Build Status](https://travis-ci.com/johnnymillergh/vuetify-typescript-playground.svg?branch=master)](https://travis-ci.com/johnnymillergh/typescript-playground)
5+
[![GitHub issues](https://img.shields.io/github/issues/johnnymillergh/vuetify-typescript-playground)](https://github.com/johnnymillergh/vuetify-typescript-playground/issues)
6+
[![GitHub forks](https://img.shields.io/github/forks/johnnymillergh/vuetiify-typescript-playground)](https://github.com/johnnymillergh/vuetiify-typescript-playground/network)
7+
[![GitHub stars](https://img.shields.io/github/stars/johnnymillergh/vuetiify-typescript-playground)](https://github.com/johnnymillergh/vuetiify-typescript-playground/stargazers)
8+
[![GitHub license](https://img.shields.io/github/license/johnnymillergh/vuetiify-typescript-playground)](https://github.com/johnnymillergh/vuetiify-typescript-playground/blob/master/LICENSE)
9+
[![Twitter](https://img.shields.io/twitter/url/https/github.com/johnnymillergh/vuetiify-typescript-playground?style=social)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fjohnnymillergh%2Fvuetiify-typescript-playground)
710

8-
### Compiles and hot-reloads for development
9-
```
11+
# Vuetify TypeScript Playground
12+
13+
**Vuetify TypeScript Playground** is a Vuetify tutorial project based on TypeScript.
14+
15+
[Official Docker Image](https://hub.docker.com/r/ijohnnymiller/vuetify-typescript-playground-prod)
16+
17+
## Features
18+
19+
Here is the highlights of **TypeScript Playground**:
20+
21+
1. Based on the most modern and latest [**Type**Script](https://github.com/microsoft/TypeScript) - [![npm version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=js&type=6&v=3.7.3&x2=0)](https://www.npmjs.com/package/typescript)
22+
3. Material components demo.
23+
4. Docker support.
24+
5. Multi-environment support.
25+
6. NGINX Gzip support.
26+
27+
## Usage
28+
29+
### Project Setup
30+
31+
Recommended IDE is the latest version JetBrains WebStorm.
32+
33+
1. Clone or download this project.
34+
35+
```shell
36+
$ git clone https://github.com/johnnymillergh/typescript-playground.git
37+
```
38+
39+
2. Project setup.
40+
41+
```shell
42+
npm install
43+
```
44+
45+
### Compiles and Hot-reloads for Development
46+
47+
```shell
1048
npm run serve
11-
```
49+
```
1250

13-
### Compiles and minifies for production
14-
```
51+
### Compiles and Minifies for Production
52+
53+
```shell
1554
npm run build
1655
```
1756

18-
### Run your unit tests
19-
```
57+
### Run Your Unit Tests
58+
59+
```sh
2060
npm run test:unit
2161
```
2262

2363
### Lints and fixes files
24-
```
64+
65+
```shell
2566
npm run lint
2667
```
2768

2869
### Customize configuration
70+
2971
See [Configuration Reference](https://cli.vuejs.org/config/).
72+
73+
## Docker Integration
74+
75+
Docker deployment can defer by environment. Here is the list of environments:
76+
77+
| # | Environment Name | Environment Alias Name | Description |
78+
| ---- | ------------------ | ---------------------- | ----------- |
79+
| 1 | development_docker | dev_dkr | |
80+
| 2 | test | test | |
81+
| 3 | stage | stage | |
82+
| 4 | production | prod | |
83+
84+
### The Procedures of Docker Deployment
85+
86+
1. Compile and minify source (can be deferred by environment, if it’s `development_docker`, then the command could be `npm run build:dev_dkr`)
87+
88+
```shell
89+
npm run build
90+
```
91+
92+
2. Build Docker image and run by Docker Compose. Available Docker Compose:
93+
94+
- development_docker
95+
- test
96+
- stage
97+
- production
98+
99+
## Maintainers
100+
101+
[@johnnymillergh](https://github.com/johnnymillergh).
102+
103+
## Contributing
104+
105+
Feel free to dive in! [Open an issue](https://github.com/johnnymillergh/typescript-playground/issues/new).
106+
107+
### Contributors
108+
109+
This project exists thanks to all the people who contribute.
110+
111+
- Johnny Miller [[@johnnymillergh](https://github.com/johnnymillergh)]
112+
-
113+
114+
115+
### Sponsors
116+
117+
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](Become a sponsor)]
118+
119+
## License
120+
121+
[Apache License](https://github.com/johnnymillergh/typescript-playground/blob/master/LICENSE) © Johnny Miller
122+
123+
2019 - Present
124+
125+
126+

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "vuetify-typescript-playground",
3-
"version": "0.1.1",
3+
"version": "0.1.2",
44
"license": "Apache-2.0",
55
"description": "Vuetify Typescript Playground",
66
"author": {

0 commit comments

Comments
 (0)