Installation

Clone the repository, install, start. About five minutes from nothing to a running site.

Edit page

Requirements

  • Node.js 20 or later. The repository pins 20.18.1 in .nvmrc.
  • Yarn, any version. Avior ships Yarn 4 in .yarn/releases and uses it automatically.
  • macOS, Windows or Linux.

No Yarn yet? Run corepack enable once. Corepack comes with Node.

Create a project

Clone the repository into a folder named after your site:

Terminal
git clone https://github.com/emagweb/avior.git my-site

Install the dependencies and start the dev server:

Terminal
cd my-site
yarn
yarn start

The site opens on localhost:3000 and reloads on every save. Every helper is available while you work, so any class you type shows up at once.

Scripts

CommandWhat it does
yarn startDev server with live reload, every generated class available.
yarn buildProduction build into build/: every route prerendered to HTML, unused classes removed.
yarn previewServes the production build, to check it before publishing.
yarn checkLists placeholders left before publishing: domain, Open Graph image, canonical link.

Next, set the look of the site in variables.