St. Augustine CHS App Website

Build Setup

# install dependencies
$ yarn install

# serve with hot reload at localhost:3000
$ yarn dev

# build for production and launch server
$ yarn build
$ yarn generate
$ yarn start

# generate static project
$ yarn generate

Node version

This project targets Node 16 for compatibility with Nuxt 2 and its PostCSS toolchain.

If you use nvm, switch automatically using the included .nvmrc:

nvm install
nvm use
yarn install

If you don't use nvm, install a Node 16 release (for example 16.20.x). Using newer Node versions (like 18/20/22) may fail during install due to engine checks in PostCSS plugins (e.g., postcss-nesting).

Optional: if you must stay on a newer Node, you can bypass engine checks while installing (not recommended for CI or production):

yarn install --ignore-engines

Note: ignoring engines may still result in runtime/build issues later. Prefer using Node 16.

Deploy to Hosting

# build
$ yarn build
$ yarn generate

# run deploy
$ yarn deploy

For detailed explanation on how things work, check out the documentation.

Special Directories

You can create the following extra directories, some of which have special behaviors. Only pages is required; you can delete them if you don't want to use their functionality.

assets

The assets directory contains your uncompiled assets such as Stylus or Sass files, images, or fonts.

More information about the usage of this directory in the documentation.

components

The components directory contains your Vue.js components. Components make up the different parts of your page and can be reused and imported into your pages, layouts and even other components.

More information about the usage of this directory in the documentation.

layouts

Layouts are a great help when you want to change the look and feel of your Nuxt app, whether you want to include a sidebar or have distinct layouts for mobile and desktop.

More information about the usage of this directory in the documentation.

pages

This directory contains your application views and routes. Nuxt will read all the *.vue files inside this directory and setup Vue Router automatically.

More information about the usage of this directory in the documentation.

plugins

The plugins directory contains JavaScript plugins that you want to run before instantiating the root Vue.js Application. This is the place to add Vue plugins and to inject functions or constants. Every time you need to use Vue.use(), you should create a file in plugins/ and add its path to plugins in nuxt.config.js.

More information about the usage of this directory in the documentation.

static

This directory contains your static files. Each file inside this directory is mapped to /.

Example: /static/robots.txt is mapped as /robots.txt.

More information about the usage of this directory in the documentation.

store

This directory contains your Vuex store files. Creating a file in this directory automatically activates Vuex.

More information about the usage of this directory in the documentation.