Installation

On this page

Quick Overview

Create Aether CMS projects with no build configuration.

npx create-aether-cms my-cms-site
cd my-cms-site
npm start

Then open http://localhost:8080 to see your site.

When you're ready to deploy to production, create a static build with npm run build.

Creating a Project

Option 1: Using npx (recommended)

npx create-aether-cms my-cms-site

Option 2: Using npm init

npm init aether-cms my-cms-site

Option 3: Using yarn create

yarn create aether-cms my-cms-site

This will create a directory called my-cms-site inside the current folder.
Inside that directory, it will generate the initial project structure and install the dependencies.

my-cms-site/
├── README.md
├── node_modules/
├── package.json
├── .gitignore
├── .env
├── index.js
├── core/
│   ├── admin/
│   ├── api/
│   ├── lib/
│   ├── routes/
│   └── utils/
├── assets/
│   ├── css/
│   └── js/
└── content/
    ├── data/
    ├── themes/
    └── uploads/

No configuration or complicated folder structures. Just the files you need to build your site.

Requirements

  • Node.js 18.x or later
  • The latest version of npm installed
  • macOS, Windows, and Linux are supported