|
1 | | -# vuetify-typescript-playground |
| 1 | + |
2 | 2 |
|
3 | | -## Project setup |
4 | | -``` |
5 | | -npm install |
6 | | -``` |
| 3 | +[](https://github.com/johnnymillergh/vuetiify-typescript-playground/releases) |
| 4 | +[](https://travis-ci.com/johnnymillergh/typescript-playground) |
| 5 | +[](https://github.com/johnnymillergh/vuetify-typescript-playground/issues) |
| 6 | +[](https://github.com/johnnymillergh/vuetiify-typescript-playground/network) |
| 7 | +[](https://github.com/johnnymillergh/vuetiify-typescript-playground/stargazers) |
| 8 | +[](https://github.com/johnnymillergh/vuetiify-typescript-playground/blob/master/LICENSE) |
| 9 | +[](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fjohnnymillergh%2Fvuetiify-typescript-playground) |
7 | 10 |
|
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) - [](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 |
10 | 48 | npm run serve |
11 | | -``` |
| 49 | + ``` |
12 | 50 |
|
13 | | -### Compiles and minifies for production |
14 | | -``` |
| 51 | +### Compiles and Minifies for Production |
| 52 | + |
| 53 | +```shell |
15 | 54 | npm run build |
16 | 55 | ``` |
17 | 56 |
|
18 | | -### Run your unit tests |
19 | | -``` |
| 57 | +### Run Your Unit Tests |
| 58 | + |
| 59 | +```sh |
20 | 60 | npm run test:unit |
21 | 61 | ``` |
22 | 62 |
|
23 | 63 | ### Lints and fixes files |
24 | | -``` |
| 64 | + |
| 65 | +```shell |
25 | 66 | npm run lint |
26 | 67 | ``` |
27 | 68 |
|
28 | 69 | ### Customize configuration |
| 70 | + |
29 | 71 | 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 | + |
0 commit comments