Nuxt Default Quickstart

Starter template for a Nuxt project using the default setup

Preview

About

This Nuxt project uses Yarn, JavaScript (no TS), Vue and Vue templates.

What is Nuxt?

The Intuitive Vue Framework

Build your next Vue.js application with confidence using NuxtJS. An open source framework making web development simple and powerful.

See the Nuxt homepage for more info.

This project uses server-side rendering with Node, but also comes with the option to generate a static site. Follow Documentation instructions below to setup and run the app locally.

Content is in the pages directory as .vue files. The Examples section of the Nuxt docs covers a Hello World example which has multiple pages and can be run in the online sandbox.

Related project:

• 

See Nuxt under Dev Resources.

Create a fresh project

See the Getting Started / Installation Nuxt docs for more info.

This project was generated with this command:

$ yarn create nuxt-app nuxt-default-quickstart

All the default options were used, as follows:

✨  Generating Nuxt.js project in nuxt-default-quickstart
? Project name: nuxt-default-quickstart
? Programming language: JavaScript
? Package manager: Yarn
? UI framework: None
? Nuxt.js modules: (Press <space> to select, <a> to toggle all, <i> to invert selection)
? Linting tools: (Press <space> to select, <a> to toggle all, <i> to invert selection)
? Testing framework: None
? Rendering mode: Universal (SSR / SSG)
? Deployment target: Server (Node.js hosting)
? Development tools: (Press <space> to select, <a> to toggle all, <i> to invert selection)
? What is your GitHub username? michaelcurrin
? Version control system: Git

Username became lowercase even though entered as MichaelCurrin. The app suggested Michael Currin, perhaps from git name rather. I don't know how this gets used.

Documentation

Installation

Install dependencies

$ yarn install

Usage

Serve with hot-reload at localhost:3000.

$ yarn dev

Deploy

Server-side rendering

Build for production and then launch the Node server.

$ yarn build
$ yarn start

Static

Generate static build output in dist directory. This can be deployed as a GitHub Pages site.

$ yarn generate

Recommended:

• Add a deploy command to package.json as per docs.
• Or use GitHub Actions to build the site and commit the site to gh-pages branch.

See info on GitHub Pages deployment in the Nuxt docs.

For detailed explanation on how things work, check out Nuxt.js docs.

License

Released under MIT by @MichaelCurrin.