Mayari

Appearance

Getting Started ​

The fastest way to get a Mayari project running is by using our scaffolding tool, but you can also set things up manually if you prefer.

Prerequisites ​

Before we start, make sure you have the following installed:

  • A Package Manager: We recommend Ember.

Visit Ember's official GitHub repo and get the binary on the releases, or if you are currently using Linux or macOS, you can instead run this:

bash
curl -fsSL https://mayari-org.github.io/docs/install-ember.sh | sh

Using the CLI ​

We created a CLI tool that handle project boilerplates for you. It sets up your folders, configures your package manager, and creates sample routes automatically.

Open your terminal and run:

bash
embx mayari-org/mayari-cli create

Once executed, the CLI will prompt you to choose a project type:

  • Standard: Scaffolds a standard backend project.
  • Bare: Scaffolds a bare project, mainly used for library development.

Then run:

bash
embr run dev

To start your development (only for standard project).