Docs/Getting Started
SETUP

Getting Started

Requirements

  1. Node 20 or greater.
  2. The ability to read. (optional)

Installation

To create an Elegance project, run npx create-elegance-app <app-name>. This installs the necessary dependencies, as well as creates the required project structure.

If you don't want the example pages and routes, run the command with -nodemo.

Run cd <app-name> to enter your project, and run it with npx elegance. If all goes well, your page should be available at localhost:3000!

Congratulations, you've just made your first Elegance page.

Next Steps

The best way to learn about a coding environment is simply by prodding around and changing some values.

The page you see at localhost:3000 is located in <project-root>/pages/page.ts(x).

We recommend going in and familiarizing yourself with where things are, and the general structure of a page. Try tweaking things like atom values, changing what text is displayed, or adding your own component.

Once you're ready, you should create your own page