Quick Start
Your First Project
Create a project with a local module and run the application in development mode.
Create a new project
Scaffold a new project with the project init command:
ajs project init my-project
The interactive wizard asks you to name your project and offers to create a new local module. Select the option to create a module — the wizard generates the module files and registers it automatically in your antelope.config.ts configuration.
Run the project
Start the project in development mode:
ajs project dev
The development server starts and loads all configured modules. Once every module completes its lifecycle, the application is ready to handle requests.
ajs project run is an alias for ajs project dev. Both commands start the project in development mode.Enable watch mode
For automatic reloading when source files change, add the --watch flag:
ajs project dev --watch
The --watch flag enables Hot Module Reloading (HMR). When you modify a module's source code, the core unloads the old version and loads the updated one without restarting the entire application.
What Happens at Startup
When you run ajs project dev, the following sequence takes place:
- The core loads and resolves module configurations from
antelope.config.ts - The core downloads and caches required modules
- The core validates the interface dependency graph (ensures all required interfaces have providers)
- Each module executes
construct()— internal state is initialized and interface implementations are registered - Each module executes
start()— all interfaces are now resolved and operational - The application is ready to serve requests