Get Started

Introduction

Antelopejs helps you build fast, stable Node.js apps. It's written in TypeScript and lets you create quality modules that work together smoothly.

Philosophy

When we were looking for the right Node.js framework, we kept running into the same frustrating problems:

Common Framework Issues

  • Most frameworks pack too many features into their core, making them hard to customize
  • Developers often need to rewrite their code just to get security updates and performance improvements
  • There's usually no safe way to update parts of your app while it's running

Antelopejs fixes these headaches with its unique approach. We've built a system where modules talk to each other through well-defined interfaces, making upgrades much smoother.

Key Features

What makes Antelopejs special? Here's what you'll love:

Interface-Based Architecture

Modules talk to each other through clean interfaces

Hot Module Reloading

Update parts of your app without restarting everything

Type Safety

Full TypeScript support for fewer bugs and better coding

Modular Design

Only use the modules you actually need

Seamless Versioning

Run different versions of the same module at the same time

Installation

Before you start, make sure you have:
  • Node.js v18.0.0 or newer
  • A text editor (VS Code works great)
  • Terminal access for running commands

To create a new project, open your terminal and run:

npx antelopejs project init <project-name>
The CLI will walk you through setup, helping you pick templates and configure your modules.