Installation

• Installing the packages
  • CLI Tool (@sodacore/create)
  • Manually
• Installing plugins

Installing the packages

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

CLI Tool (@sodacore/create)

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

bun create @sodacore@alpha

The @alpha tag is needed to tell Bun to use the alpha version of the package, until we hit a v1 release.

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:

Manually

You can install the framework pretty easily using bun but of course, you can use any package manager you want.

For the purposes of every tutorial, as it's a Bun framework, we will assume you intend to use bun as your package manager, but feel free to switch it out.

bun install @sodacore/core @sodacore/http

Installing plugins

To install a plugin, simply find the package name, for core-packages, they are usually prefixed with @sodacore/ and for community ones, we suggest: sodacore-plugin-mypluginname to make it easier for people to search, some community packages may be taken in house as part of our core offering if they get a lot of love.

You can find a list of our packages here: Packages, we are always expanding the offering.