Nuxt.js Template

Full-featured template for JAMstack websites using nuxt.js

Deploy your own copy of this project on Netlify in just a few clicks:

About

I built this template with all the tools I found useful to develop my own personal projects, so it can be a bit biased. If you find something that you think is not relevant or could be improved, please open an issue or a pull request to fix it.

Features

Vue.js + TypeScript

• Because I love strongly typed languages (I'm a bit of a java developer at heart)

Linting

• Don't bother with linting ever again. Let Prettier handle it for you. Pre-commit hook included to lint your staged files.

Testing Setup

• Unit tests with Jest and Vue Test Utils
• E2e tests with Cypress (runs in the CI)

UI

• Multiple color themes
• Leverage the power of Tailwind CSS to build beautiful interfaces. You will find a Tailwind config file that you can customize to build your own theme.
• You can also use conventional scss style in the components.
• FontAwesome icons ready to use.

SEO

• Populate each page header metadata with name, description, image, etc.

Accessibility

• i18n preconfigured with two locales (English and French)

PWA

• Users can install the application on their device and run it offline

Deployment

• Example of CI with Travis-CI
• Ready to deploy on Netlify using git integration

Installation

Clone the repository and install the dependencies:

git clone https://github.com/jsulpis/nuxtjs-template.git && cd nuxtjs-template && yarn

Usage

Development

Serve with hot reload at localhost:3000.

yarn dev

Build

If you want a JAMstack website: generate a fully static project with pre-rendered pages to put directly on a server or any hosting platform.

yarn generate

If you want to serve your website with SSR:

yarn build
yarn start

Deployment

This template is ready to be deployed on Netlify:

See the Deployment section of the documentation for more information.

You can integrate Netlify with your GitHub account, which will allow it to deploy each branch and pull request to their own environment, and the master branch in production.

Configuration

See the documentation

License

Although you don't have to, if you reuse this template for your projects I would appreciate it if you would credit me and provide a link to my GitHub profile in the footer. Thanks !

Released under the MIT license.