Nuxt 3 template

Note: This template is for development purposes only. It is not recommended to use this template in production without purchasing Nuxt UI Pro. You can purchase it here

The first version of the template using Nuxt Materialize theme will be kept permanently free and open-source.

Nuxt 3 template is a opinionated template for Nuxt 3 project. It includes the following features:

• Tailwindcss for utility-first CSS
• Nuxt UI for component library
• Nuxt i18n for internationalization
• LogTo for user management and authentication
• Drizzle ORM for Database communication
• CASL for Access Control
• Firebase Notification for push notification

Getting Started

Prerequisites

• PNPM - Fast, disk space efficient package manager
• Node.js 20+ - Recommend to be installed via PNPM standalone using pnpm env use --global

Installation

1. Clone the repository

git clone [email protected]:thecodeorigin/nuxt-template.git

2. Install dependencies

pnpm install

3. Prepare the environment

Copy the .env.example file to .env and fill in the necessary information

cp .env.example .env

4. Prepare the Database with Docker

You can use a remote database and fill in all the environment variables in the .env file. Or you can use the provided docker-compose file to start a local database.

Please be careful with your configured environment variables, you can accidentally execute the database commands on your production database.

pnpm db:start

pnpm db:migrate

You can stop or reset the database with the following commands:

# Stop the database
pnpm db:stop
# Reset the database
pnpm db:reset

5. Run the project

pnpm dev

Usage with Doppler

You can use Doppler to manage your environment variables. To do this, you need to install the Doppler CLI and authenticate with your account.

1. Install the Doppler CLI

Please follow the instructions on the official Doppler documentation to install the Doppler CLI.

2. Authenticate with Doppler

doppler login

3. Select the project from Doppler

doppler setup

4. Run the project with Doppler

Please be careful with your configured environment variables, you can accidentally execute the database commands on your production database.

pnpm with-env dev

Contribution

Thank you to all the people who already contributed to the Nuxt Template project!

License

MIT

Copyright (c) 2022-present, Nguyen Huu Nguyen Y

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!