https://github.com/binodnepali/nuxt-with-typescript-example-template
Nuxt3 with typescript example template.
https://github.com/binodnepali/nuxt-with-typescript-example-template
nuxt-typescript nuxt3-starter nuxt3-template nuxtjs-starter nuxtjs-template
Last synced: 5 months ago
JSON representation
Nuxt3 with typescript example template.
- Host: GitHub
- URL: https://github.com/binodnepali/nuxt-with-typescript-example-template
- Owner: binodnepali
- Created: 2022-10-29T17:52:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-28T21:35:26.000Z (over 2 years ago)
- Last Synced: 2025-06-11T02:44:38.274Z (about 1 year ago)
- Topics: nuxt-typescript, nuxt3-starter, nuxt3-template, nuxtjs-starter, nuxtjs-template
- Language: Vue
- Homepage:
- Size: 696 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nuxt With Typescript Example Template
[](http://commitizen.github.io/cz-cli/)
An example template scaffolded using [nuxt](https://nuxt.com/docs/getting-started/installation) with typescript and [sass](https://sass-lang.com/) to start a new project.
## Why this template
This template includes pre-installed plugins suchas [prettier](https://prettier.io/), [eslint](https://eslint.org/), [stylelint](https://stylelint.io/), [lint-staged](https://github.com/okonet/lint-staged), [commitlint](https://commitlint.js.org/) and [standard version](https://github.com/conventional-changelog/standard-version) which helps to maintain project code quality.
## Before getting started
Make sure you have installed [Node.js 18 or higher](https://nodejs.org/en/) on your machine. You can use [nvm](https://github.com/nvm-sh/nvm) to manage multiple node version on your machine.
## Getting started
You can setup this project using [npm](https://docs.npmjs.com/about-npm) or [yarn](https://yarnpkg.com/getting-started) or [pnpm](https://pnpm.io/) package managers.
### Clone repo
```bash
# https
git clone https://github.com/binodnepali/nuxt-with-typescript-example-template.git
# or
# ssh
git clone git@github.com:binodnepali/nuxt-with-typescript-example-template.git
```
### Navigate to cloned repo
```bash
cd nuxt-with-typescript-example-template
```
### Setup
Make sure to install the dependencies:
```bash
# pnpm
pnpm i
# or
# yarn
yarn i
# or
# npm
npm install
```
### Development Server
Start the development server on [http://localhost:3000](http://localhost:3000)
```bash
# pnpm
pnpm dev
# or
# yarn
yarn dev
# or
# npm
npm run dev
```
### Build
Build the application for production
```bash
# pnpm
pnpm build
# or
# yarn
yarn build
# or
# npm
npm run build
```
### Preview
Locally preview production build
```bash
# pnpm
pnpm i
# or
# yarn
yarn preview
# or
# npm
npm run preview
```
### Lint
```bash
# pnpm
pnpm lint
# or
# yarn
yarn lint
# or
# npm
npm run lint
```
### Lint fix
```bash
# pnpm
pnpm lint:fix
# or
# yarn
yarn lint:fix
# or
# npm
npm run lint:fix
```
### Lint style
```bash
# pnpm
pnpm lint:style
# or
# yarn
yarn lint:style
# or
# npm
npm run lint:style
```
### Lint style fix
```bash
# pnpm
pnpm lint:style:fix
# or
# yarn
yarn lint:style:fix
# or
# npm
npm run lint:style:fix
```
### Commit
Open interactive terminal to write conventional commit message
```bash
# pnpm
pnpm commit
# or
# yarn
yarn commit
# or
# npm
npm run commit
```
### Release
Create a release tag and generates change log based on commit history
```bash
# pnpm
pnpm release
# or
# yarn
yarn release
# or
# npm
npm run release
```
## References
* Checkout the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.