Get Started

Project

Your Antelopejs project brings together modules that work as a team. Each module has its own job and settings.

Create a project

Getting started with Antelopejs is super easy. The CLI wizard walks you through creating a new project step by step.

Most projects have your own application module plus other modules that provide services your app needs.

Run this command:

npx ajs project init <project-name>

yarn dlx ajs project init <project-name>

pnpm dlx ajs project init <project-name>

Answer a few questions to set up your project file

The CLI will create an antelope.json file based on your answers.

Add your code module

You can either add your existing code or create a new module from a template.

Manage your project

Everything in your project revolves around the antelope.json file. This file tells Antelopejs:

What modules to load
How to configure each module
Different settings for different environments
Where to find each module

The CLI gives you simple commands to add, remove, and update modules. Check out the CLI documentation for details on all the commands.

Want to know all the options available in the antelope.json file? See the Folder Structure chapter.

Architecture

Let's dig into how Antelopejs is built - you'll see how its design helps you create modular apps that are easy to update and extend.

Module

Modules are the building blocks of your Antelopejs app. They talk to each other through interfaces - exporting features others can use, and importing features they need.