Documentation v1.x · 43 pages
AntelopeJS framework documentation: Build with contracts. Swap the rest.
Start with a working application. Learn how modules fit together, then go deeper only where you need to.
01 · install
npm install -g @antelopejs/core 02 entry points
What are you building?
- Build your first application Install the CLI, create a project and run your first module. /docs/get-started/installation
- Bring an existing server Let your application own the process and embed the module runtime. /docs/guides/embedded-runtime
- Create a reusable module Define a boundary, implement its lifecycle and test its contract. /docs/module-development/creating-a-module
03 the model
One contract. Two sides.
Separate what your module needs from how a provider delivers it. Explore the three views below.
Consumer Your business module
importsInterface The shared contract
implementsProvider The implementation
// Both modules depend on the contract.
Consumer --imports--> Interface
Provider --implements--> Interface
// The application selects the provider module.Both modules depend on the contract.
Your consumer imports the interface package. The provider implements that same contract. The consumer does not import the provider.
04 reference
Find the detail you need
05 start here