Skip to content

inputstudio/nuxt3-starter

Repository files navigation

Nuxt 3 Starter

This is an minimal—opinionated starter template for Nuxt 3. It is based on the what we use and love at Input Studio.

Look at the Nuxt 3 documentation to learn more.

Features

Don't worry, if you don't need something, you can remove it.

  • 👓 Sass and Tailwind CSS
  • Headless UI components
  • 🇬 Google Fonts module
  • 🪛 Eslint and Prettier with Tailwind plugin (automatically sorts classes based on recommended class order)
  • ⚙️ VS Code settings and recommended extensions
  • 🐋 Dockerfile optimized for production (also includes a GitHub Actions workflow to build and publish the Docker image)

Setup

Yeah, yarn is better than npm. But you can still use npm if you want.

# Create a new Nuxt 3 project using this starter template:
npx nuxi init -t gh:inputstudio/nuxt3-starter <project-name>
# Go to the project directory:
cd <project-name>
# Install the dependencies:
yarn install
# Start the development server:
yarn dev

Production

# Build the application for production:
yarn build
# Preview production build:
yarn preview

Check out the deployment documentation for more information.

Docker

Building and running your application

When you're ready, start your application by running: docker compose up --build.

Your application will be available at https://localhost:3000.

Deploying your application to the cloud

First, build your image, e.g.: docker build -t myapp .. If your cloud uses a different CPU architecture than your development machine (e.g., you are on a Mac M1 and your cloud provider is amd64), you'll want to build the image for that platform, e.g.: docker build --platform=linux/amd64 -t myapp ..

Then, push it to your registry, e.g. docker push myregistry.com/myapp.

Consult Docker's getting started docs for more detail on building and pushing.

References