https://github.com/ljlm0402/typescript-vue-starter
🚀 TypeScript VueJs Starter
https://github.com/ljlm0402/typescript-vue-starter
composition-api nodejs npx typescript vue vue-i18n vue-router vuex vuex-state-storage
Last synced: 7 months ago
JSON representation
🚀 TypeScript VueJs Starter
- Host: GitHub
- URL: https://github.com/ljlm0402/typescript-vue-starter
- Owner: ljlm0402
- License: mit
- Created: 2020-03-03T01:15:34.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-27T02:44:14.000Z (about 4 years ago)
- Last Synced: 2025-03-01T21:35:43.074Z (7 months ago)
- Topics: composition-api, nodejs, npx, typescript, vue, vue-i18n, vue-router, vuex, vuex-state-storage
- Language: TypeScript
- Homepage: http://npm.im/typescript-vue-starter
- Size: 1.98 MB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[Vue.js](https://vuejs.org/) with [TypeScript's](https://www.npmjs.com/package/typescript) application generator.
## 🧐 What is Vue?
Vue is a progressive framework for building user interfaces.
Unlike other monolithic frameworks, Vue is designed from the ground up to be incrementally adoptable.
The core library is focused on the view layer only, and is easy to pick up and integrate with other libraries or existing projects.
## 🤔 Why typescript-vue-starter?
currently vue3 has greatly enhanced TypeScript support.
However, the @vue/cli module has limitations due to various design patterns and template structures,
so it was created by combining modules that are useful in practice.
## 🚀 Quick Start
### Install with the npm global package
```sh
$ npm install -g typescript-vue-starter
```
### Run npx to install the package
npx is a tool in the JavaScript package management module, npm.
This is a tool that allows you to run the npm package on a single run without installing the package.
If you don't specify a project name, the default _typescript-vue-starter_ will be used instead.
```bash
$ npx typescript-vue-starter "project name"
```
Choose the template you want. We will create more templates later.
### Select a templates
Start your typescript-vue-starter app in development mode at `http://localhost:8080/`
```bash
$ cd "project name" && npm run serve
```
## 🎠 Available commands for the server.
- Run the Server : `npm run serve`.
- Build Static File: `npm run build`.
- Check for linting errors: `npm run lint`.
- Fix linting errors: `npm run lint:fix`.
## 🗂 Code Structure (default)
```bash
│
├── /public
│ ├── favicon.ico
│ └── index.html
│
├── /src
│ ├── /assets
│ │ └── logo.png
│ │
│ ├── /components
│ │ └── HelloWorld.vue
│ │
│ ├── /helpers
│ │ ├── common.ts
│ │ ├── error.ts
│ │ └── http.ts
│ │
│ ├── /locales
│ │ ├── ENG.json
│ │ └── KOR.json
│ │
│ ├── /mixins
│ │ └── index.ts
│ │
│ ├── /plugins
│ │ └── i18n.ts
│ │
│ ├── /router
│ │ └── index.ts
│ │
│ ├── /store
│ │ ├── /users
│ │ │ └── index.ts
│ │ │
│ │ ├── actions.ts
│ │ ├── getters.ts
│ │ ├── index.ts
│ │ ├── interface.ts
│ │ ├── mutations-types.ts
│ │ ├── mutations.ts
│ │ └── states.ts
│ │
│ ├── /views
│ │ ├── About.vue
│ │ └── Home.vue
│ │
│ ├── App.vue
│ ├── main.ts
│ ├── shims-tsx.d.ts
│ ├── shims-vue.d.ts
│ └── types.d.ts
│
├── .browserslistrc
├── .dockerignore
├── .editorconfig
├── .eslintrc.js
├── .gitignore
├── babel.config.js
├── docker-compose.yml
├── Dockerfile
├── Makefile
├── nginx.conf
├── package.json
└── tsconfig.json
```
## 📬 Recommended Commit Message
| When | Commit Message |
| :----------------- | :------------------- |
| Add function | ⚡️ Add function |
| Fix bug | 🐞 Fix bug |
| Refactoring | 🛠 Refactoring |
| Add package | 📦 Add package |
| Fix readme | 📚 Fix readme |
| Improvements style | 👁 Improvements style |
| New Releases | 🎉 Releases |
## 💳 License
[MIT](LICENSE)
## 🤝 Contributors
- freevue [https://github.com/freevuehub](https://github.com/freevuehub)