README.md

nuxt3-boilerplate

💚 Stable, compatible, powerful, clear, production ready 📦👌

_{Buy me a coffee - Sponsorship 💖}

Getting Started

Init Project Locally

Install Node.js >=18.12.0 and run the following command:

 

Installation

Git clone.

$ git clone https://github.com/selimdoyranli/nuxt3-boilerplate.git

 

Build Setup

$ cd nuxt3-boilerplate

# install dependencies
$ yarn install

# serve with hot reload at localhost:3000
$ yarn dev

# build server target project
$ yarn build

# serve production mode (Server target)
$ yarn start

# generate static project
$ yarn generate

# serve production mode (Static target)
$ yarn preview

Linter

# run eslint for js & vue files
$ yarn lint:eslint

# run eslint fix for js & vue files
$ yarn lint:eslint:fix

# run stylelint for vue & style files
$ yarn lint:stylelint

# run stylelint fix for vue & style files
$ yarn lint:stylelint:fix

# run prettier
$ yarn prettier

Git

# add files
$ git add .

# generate commit message
$ yarn cz # or 'yarn commit'

# push
$ git push

---

Tech Stack

• Nuxt - Nuxt3 vue framework
• Pug
• Scss
• Typescript
• Pinia - State management
• Husky
• Eslint
• Stylelint
• Prettier
• Conventional Commit
• Commitlint
• Commitizen
• Changelogen - Release management
• Volar

Sponsorship

You can sponsor me for the continuity of my projects:

License

MIT License © 2023 selimdoyranli