Skip to main content

Getting Started

Prerequisites​

TypeScript​

Minimum version: >=5.2.2

We strongly recommend using TypeScript when working with declo for the best developer experience when defining your configuration and using the client library.

If you for some reason do not wish to use TypeScript, you can of course use plain JavaScript as well. Depending on your editor, you might still get some type hints.

Installation​

To install and start configuring declo in your project, run:

npm install @declo/config --save-dev

Creating a configuration​

Configuring declo is done through a fluent / builder like interface, designed to be linear and easy to follow and extend.

Start by creating a declo.config.ts file anywhere in your project with the following:

note

The name of the file is not important, but we will be referring to it as declo.config.ts throughout the documentation.

declo.config.ts
import { DecloConfig } from '@declo/config'

export default DecloConfig()

This is the starting point for configuring declo.

These sections will guide you through the different parts of the configuration: