Skip to content

Installation

Installing the packages

There are two ways of getting started, manually, or via our CLI (recommended).

Quick note, you can technically use any package manager you want, but consider we are using the bun runtime, all examples will use the bun package manager.

CLI Tool (@sodacore/create)

To get started with the CLI tool, you can simply run the following:

zsh
bun create @sodacore
bun create @sodacore@beta # for latest beta version.
bun create @sodacore@alpha # for latest alpha version. (use until we hit v1)

This will install and launch the command line, it simply asks you about your project, and then installs the packages and writes the files, it will also modify the directory to correctly reflect the Sodacore project structure.

We recommend this way due to simplicity, see below:

Once you have done this, you can skip right to the Packages section to see what packages you can install and learn how to use the different core plugins.

Manually

So you want to do it yourself? No problem.

Keep following to setup your project manually.

Released under the Apache-2.0 License.