Skip to content

MichaelCurrin/nuxt-static-quickstart

Repository files navigation

Nuxt Static Quickstart

Starter template for a Nuxt project using the static setup

GitHub tag License

Made with Node.js Made with Yarn

Package - nuxt Package - vue

Preview

Sample screenshot

Use this template

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.

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:

  • MichaelCurrin - nuxt-default-quickstart

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-static-quickstart

The SPA, static and jsconfig.json options were chosen as different from the default values.

? Project name: nuxt-static-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: Single Page App
? Deployment target: Static (Static/Jamstack hosting)
? Development tools: jsconfig.json (Recommended for VS Code if you're not using typescript)
? What is your GitHub username? michaelcurrin
? Version control system: Git

Documentation

Installation

Install dependencies

$ yarn install

Usage

Serve with hot-reload at localhost:3000.

$ yarn dev

Deploy

Build

Build for production.

$ yarn build

Launch server.

$ yarn start

Static

Generate static build output in dist directory. This seems to need the build command first. 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.

About

Starter template for a Nuxt project using the static setup

Topics

Resources

License

Stars

Watchers

Forks