Nuxt 3 Boilerplate with TypeScript, PrimeVue, and Tailwind CSS

This is a boilerplate codebase for starting a Nuxt 3 project with TypeScript, PrimeVue, and Tailwind CSS. It includes a recommended folder structure and naming conventions for your project.

Prerequisites

Make sure you have Node.js version 18 or higher installed.

Recommended IDE Setup

• VS Code + Vue - Official + Tailwind CSS IntelliSense

Installation

1. Clone this repository. git clone https://github.com/ekady/del-nuxt-starter.git

2. Navigate to the project directory. cd del-nuxt-starter

3. Install the project dependencies using Pnpm. pnpm install

Development Mode

To run the project in development mode, use the following command: pnpm dev

Build

To build the project, use the following command: pnpm build

Preview Build

To preview the build, use the following command: pnpm preview

Folder Structure

/
├── app/
│    ├── assets/
│    │   ├── images/
│    │   │   └── ....(your images) /
│    │   ├── scss/
│    │   │   └── ....(your scss) /
│    │   └── .... (your assets resources)
│    │
│    ├── components/
│    │   ├── base/
│    │   │   └── ... (your base component) /
│    │   ├── features/
│    │   │   ├── todo /
│    │   │   │    └── ... (todo components)
│    │   │   └── ... (other features resources)
│    │   ├── layout/
│    │   │   └── ... (your layout component) /
│    │   └── ...(other component resources)
│    │
│    ├── composables/
│    │   ├── common/
│    │   │   └── ....(common composables) /
│    │   └── .... (your composables resources)
│    │
│    ├── config/
│    │   ├── bus/
│    │   │   └── index.ts
│    │   └── ...(your config resources)
│    │
│    ├── constants/
│    │   ├── auth/
│    │   │   └── authApi.ts
│    │   └── ...(your constants resources)
│    │
│    ├── layouts/
│    │   │   └── default.vue
│    │   └── ...(your layouts resources)
│    │
│    ├── middleware/
│    │   │   └── protected.global.ts
│    │   └── ...(your middleware resources)
│    │
│    ├── pages/
│    │   │   └── index.ts
│    │   └── ...(your page routes resources)
│    │
│    ├── plugin/
│    │   │   └── api.ts
│    │   └── ...(your plugin resources)
│    │
│    ├── stores/
│    │   │   └── auth.ts
│    │   └── ...(your stores resources)
│    │
│    ├── typings/
│    │   │   └── auth.ts
│    │   └── ...(your type resources)
│    │
│    └── ... (other source code)
│
├── lang/
│    ├── en/
│    │   │   └── auth.json/
│    │   └── .... (other english json resources)
│    ├── id/
│    │   │   └── auth.json/
│    │   └── .... (other indonesian json resources)
│    └── ... (your lang json resources)
│
└── server/
     ├── api/
     │   │   └── pageview.ts/
     │   └── .... (other api resources)
     ├── middleware/
     │   │   └── log.ts/
     │   └── .... (other api middlewarre resources)
     └── ... (your server resources)

License

This project is licensed under the MIT License.