https://github.com/michaelcurrin/nuxt-static-quickstart
Starter template for a Nuxt project using the static setup
https://github.com/michaelcurrin/nuxt-static-quickstart
javascript nuxt quickstart starter static-site template
Last synced: 27 days ago
JSON representation
Starter template for a Nuxt project using the static setup
- Host: GitHub
- URL: https://github.com/michaelcurrin/nuxt-static-quickstart
- Owner: MichaelCurrin
- License: mit
- Created: 2021-03-25T18:01:45.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-05-20T09:20:10.000Z (about 5 years ago)
- Last Synced: 2025-03-04T15:47:29.731Z (over 1 year ago)
- Topics: javascript, nuxt, quickstart, starter, static-site, template
- Language: Vue
- Homepage:
- Size: 59.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nuxt Static Quickstart
> Starter template for a Nuxt project using the static setup
[](https://github.com/MichaelCurrin/nuxt-static-quickstart/releases/)
[](#license)
[](https://nodejs.org)
[](https://yarnpkg.com/)
[](https://www.npmjs.com/package/nuxt)
[](https://www.npmjs.com/package/vue)
## Preview
[](https://github.com/MichaelCurrin/nuxt-static-quickstart/generate)
## 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](https://nuxtjs.org/) for more info.
Follow [Documentation](#documentation) instructions below to setup and run the app locally.
Content is in the [pages](/pages/) directory as `.vue` files. The [Examples](https://nuxtjs.org/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:
- [](https://github.com/MichaelCurrin/nuxt-default-quickstart)
## Create a fresh project
See the [Getting Started / Installation](https://nuxtjs.org/docs/2.x/get-started/installation) Nuxt docs for more info.
This project was generated with this command:
```sh
$ 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 to select, to toggle all, to invert selection)
? Linting tools: (Press to select, to toggle all, 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
```sh
$ yarn install
```
### Usage
Serve with hot-reload at `localhost:3000`.
```sh
$ yarn dev
```
### Deploy
#### Build
Build for production.
```sh
$ yarn build
```
Launch server.
```sh
$ 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.
```sh
$ 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](https://nuxtjs.org/docs/2.x/deployment/github-pages/) in the Nuxt docs.
For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org).
## License
Released under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).