Nuxt 3 Minimal Typescript and Tailwind Starter Kit

We recommend to look at the documentation.

Nuxt Starter Kit is an opinionated boilerplate based off of Nuxt3(beta), with all the essentials you would want ready, up and running when starting a Nuxt project to play and experiment with.

Out of the box you get all the essentials

• Typescript strict typescheck setup Do read this
• Tailwind Module via Nuxt Tailwind Module for zero configuration start and view config via http://localhost:3000/_tailwind/
• editorconfig for Consistent styling
• ESLint for static code analysis (added but it's currently failing due to #171) and
• Prettier for code formatting

and more...

Note:

🚧 Nuxt 3 is currently in beta and is not yet production ready.

But we will make sure the broilerplate updated with latest updates and conventions when required

Quick Start

The best way to start with this template is to click "Use this template" above, create your own copy and work with it or clone directly to your machine

git clone [email protected]:clarity-tech/nuxt-starter-kit.git

Setup

Make sure to install the dependencies

yarn install

Development

To start the project locally, run:

yarn dev

which kickstarts the nuxt3 development and build server nuxi. Open http://localhost:3000 with your browser to see the result.

Production

Build the application for production:

yarn build

Checkout the deployment documentation.

Check package.json for the full list of commands available at your disposal.

## Known Issues just for code linting in development

- [ESLint](https://github.com/nuxt/eslint-config/issues/171) - Once the issue is resolved you can add
```json
        "*.+(js|ts|vue)": [
            "yarn run lint"
        ],

in package.json under the lint-staged section for linting on commits

License

MIT