Installation

Elegant is a simple and free framework for rapidly building SEO-friendly websites, super fast full-stack web applications. Elegant is the perfect starting point for creating your next blog, or documentation website.

This guide will show you how to download, install, and get started with Elegant. 🚀

---

Video Tutorial

---

Requirements

Before creating your first Elegant application, you should ensure that your local machine has Node and NPM installed.

Installation

The next step is to install the Elegant CLI tool via npm.

npm install elegant-cli

After you have installed the Elegant CLI tool, you may create a new Elegant documentation project via the NPM npx elegant-init command:

npx elegant-init

Starting Elegant

After the project has been created, simply start Elegant’s local development server using npm:

npm run dev

Once you have started the Elegant development server, your application will be accessible in your web browser at http://localhost:3000/docs.

To stop the Elegant development server, press the ctrl and c keys together in the terminal:

ctrl + c

Initial Configuration

Elegant needs almost no additional configuration out of the box. You are free to get started developing!

Environment Based Configuration

Since many of Elegant’s configuration option values may vary depending on whether your application is running on your local machine or on a production web server, many important configuration values are defined using the .env file that exists at the root of your application.

Your .env file should not be committed to your application’s source control, since each developer/server using your application could require a different environment configuration. Furthermore, this would be a security risk in the event an intruder gains access to your source control repository since any sensitive credentials would get exposed.

Note

For more information about the .env file and environment based configuration, check out the full configuration documentation.