Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nuxt-community/typescript-template
Typescript starter for Nuxt 2
https://github.com/nuxt-community/typescript-template
nuxt nuxt-template typescript vue
Last synced: about 1 month ago
JSON representation
Typescript starter for Nuxt 2
- Host: GitHub
- URL: https://github.com/nuxt-community/typescript-template
- Owner: nuxt-community
- License: mit
- Created: 2017-04-26T22:28:14.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-09-20T16:43:05.000Z (about 1 month ago)
- Last Synced: 2024-09-23T17:33:05.337Z (about 1 month ago)
- Topics: nuxt, nuxt-template, typescript, vue
- Language: Vue
- Homepage: https://nuxt-ts-template.netlify.app/
- Size: 795 KB
- Stars: 643
- Watchers: 12
- Forks: 114
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nuxt TypeScript starter template
A [Nuxt 2](https://github.com/nuxt/nuxt.js) + [@nuxt/typescript](https://github.com/nuxt/typescript) starter project template.
## Setup
Create your repository by [Use this template](https://github.com/nuxt-community/typescript-template/generate) button from [this template](https://github.com/nuxt-community/typescript-template) and clone into your local.
Then, run below command and follow its message.
```
./init.sh
```
The command will ask your preference for the API to write Vue component among:
- Options API
- Class API with with nuxt-property-decorator
- Composition API (Experimental) with [@nuxt/composition-api](https://github.com/nuxt-community/composition-api)
## Usage
### Run Development server
```sh
npm run dev
```
Go to [http://localhost:3000](http://localhost:3000)
### Build/Run SSR enabled application
```sh
npm run build
npm start
```
### Static Generation
[](https://nuxt-ts-template.netlify.com/)
```sh
npm run generate #=> Then distribute /dist
```
## FAQ
- Q. How about providing sample usage of "xyz" (The name of OSS which you want to use)?
- A. Recommend running into [create-nuxt-app](https://github.com/nuxt/create-nuxt-app). This template aims to provide a minimal sample that follows the latest version of Nuxt.js and [@nuxt/typescript](https://github.com/nuxt/typescript).
- Q. I think the usage of Vuex is not typed enough...?
- A. We know! We desire the next major version of Vuex (v4) saves our bacon.
## Miss the old way of this repository?
That still alives on [master](https://github.com/nuxt-community/typescript-template/tree/master) branch.