Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 1.6 KB

README.md

File metadata and controls

73 lines (48 loc) · 1.6 KB
Raw

Nuxt 3 Starter

With eslint, stylelint, pinia, and pre-commit hooks

  • Stylelint
  • Eslint
  • Prettier
  • Husky & lint-staged
  • Pinia
  • Basic directory structure including /components, /layouts, /pages, and /assets
  • SCSS
  • Engine versioning with nvm

Make it your own

This repository is set up using npm, however you can edit package.json to use yarn.

It comes with a basic css reset, which can be found in assets/styles/reset.scss. Feel free to amend, remove, and use your own!

It's configured with husky and lint-staged to ensure your code stays clean with each commit ✨ It uses @antfu/eslint-config; for more information on how to customise your linting config, visit https://github.com/antfu/eslint-config

To learn more about how to customise your stylelint configuration, visit https://stylelint.io/user-guide/configure/

Getting Started

Set your node version with nvm

❗️If you do not already have nvm installed, you can install it here: https://github.com/nvm-sh/nvm

Set the correct engine versions using nvm:

nvm use

Look at the Nuxt 3 documentation to learn more.

Install Dependencies

To install dependencies:

# npm
npm install

Development Server

Start the development server on http://localhost:3000:

# npm
npm run dev

Production

Build the application for production:

# npm
npm run build

Locally preview production build:

# npm
npm run preview

Check out the deployment documentation for more information.