Nuxt TypeScript Starter Template is an open-source boilerplate for building Nuxt 2 applications with TypeScript, maintained by the nuxt-community organization. It pairs Nuxt 2 with @nuxt/typescript to give developers a TypeScript-ready project that can be customized for different Vue component API styles.
What is Nuxt TypeScript Starter Template?
It is a minimal starter template that combines Nuxt 2 with the @nuxt/typescript module, providing a TypeScript-configured project out of the box. You create a repository from the GitHub template, run the init.sh script, and the template generates a project with development, SSR build, and static generation scripts. The repository currently has 635 stars on GitHub and is maintained by the nuxt-community team.
Key Features
- API style selection — Running ./init.sh prompts you to choose among Options API, Class API with nuxt-property-decorator, or the experimental Composition API via @nuxt/composition-api, then configures the project according to your choice.
- TypeScript integration — The project is pre-wired with @nuxt/typescript, so Vue components, store, and configuration files are type-checked without additional setup.
- SSR and static generation commands — Standard npm scripts include npm run dev, npm run build, npm start for server-rendered apps, and npm run generate to output a static site into the dist directory.
- Minimal by design — The template deliberately avoids sample implementations of third-party libraries, keeping dependencies focused on the core Nuxt and TypeScript stack.
- GitHub template support — You can create a new repository instantly via the "Use this template" button on the repository page, then clone it locally and run init.sh.
- Netlify-ready demo — The repository includes a deployment badge pointing to a live demo at nuxt-ts-template.netlify.com, showing the generated output in action.
Who should use Nuxt TypeScript Starter Template?
- Nuxt 2 developers adopting TypeScript — If you have an existing Nuxt 2 workflow and want a minimal, current baseline of @nuxt/typescript configuration, this template gives you exactly that without extra clutter.
- Teams evaluating Vue component API styles — The init.sh script lets you compare Options API, Class API, and Composition API in the same Nuxt project, which is useful for deciding on a team-wide standard.
- Open-source contributors — Because the repository is maintained by nuxt-community, contributors can use it as a starting point for building and testing Nuxt modules that need TypeScript support.
Use cases
- Starting a new TypeScript Nuxt project: Use the template, run init.sh, choose an API style, and you have a working Nuxt 2 + TypeScript app with dev, build, and generate scripts ready.
- Learning TypeScript with Nuxt: The minimal codebase makes it easy to see exactly how Nuxt 2 and @nuxt/typescript connect, without framework-generated wrapper code obscuring the essentials.
- Generating a static site: Run npm run generate and the template outputs a fully static version of your app into the dist directory, suitable for hosting on any static file server or CDN.
How does it work?
Setup takes two steps. First, create a repository from the github.com/nuxt-community/typescript-template page using the "Use this template" button and clone it locally. Second, run ./init.sh, which asks which Vue component API style you prefer — Options, Class with nuxt-property-decorator, or Composition (experimental) via @nuxt/composition-api — and customizes the project files based on your answer.
FAQ
Is this template free to use?
The template is an open-source project on GitHub under the nuxt-community organization, so it is free to use, modify, and distribute. No license restrictions are mentioned in the repository.
Why does the template not include examples of using other libraries?
The repository maintainers intentionally keep the template minimal and focused on the latest Nuxt.js and @nuxt/typescript versions. For sample usage of specific OSS libraries, they recommend using create-nuxt-app instead.
Does the template provide strong typing for Vuex?
Not yet. The maintainers acknowledge that the Vuex usage is not fully typed and are waiting for the next major version of Vuex (v4) to improve the situation.
Where can I find the old version of this template?
The previous layout of the repository is still available on the master branch of github.com/nuxt-community/typescript-template. The current default branch contains the new setup with init.sh.
Alternatives
- create-nuxt-app — An official scaffolding tool for Nuxt projects that offers an interactive setup wizard with more options, including UI frameworks and linting tools, making it a fuller-featured alternative to this minimal template.
