Docs/Getting Started

Getting Started

Requirements

  1. Node 20.11 or greater.
  2. The ability to read! (important)

Installation

The easiest way to make an Elegance project is: npx create-elegance-app my-app

This installs the necessary dependencies, as well as creates the required project structure. You can also npm install elegance-js && npx bootstrap in a folder.

Once it's complete, you can run: npx elegance in the project's folder, which will start the dev server.

The dev server will be live here: localhost:3000

Next Steps

The best way to learn Elegance (in our opinion) is to just prod around. The demo project includes most of the features, and is quite simple to understand; especially if you've used frameworks like NextJS before.

The page you see at localhost:3000 is located in my-app/pages/page.tsx. You should read it, it's quite short.

Once you're understand the general layout of the project, you can create your own page