Like in most cases, a local environment is usually the best start. It makes exploring and playing around with different setups easier.
To make things easier, we’ve prepared a short Youtube step-by-step guide.
https://www.youtube.com/watch?v=8embizFvI-U
In order to run OrbisDB you need to set up 3 main components:
If you want to know the role of each components, check out our architecture overview (link).
OrbisDB and Ceramic utilize NodeJS and its native package manager, so you need to have them installed before continuin.
You can do so using one of the package managers or running a NodeJS installer.
Alternatively, if you need to manage multiple NodeJS versions due to your other projects, NVM (Node Version Manager) is recommended (MacOS, Linux, Windows).
Since OrbisDB is built on top of Ceramic’s event protocol, it makes sense to start by setting up your Ceramic Node.
Ceramic does not officially support Windows. You follow the setup using Windows WSL. Alternatively, you can use a Managed Ceramic Node (link) or check out Orbis Studio (link) for a fully managed experience powered by Orbis.
You can check out Ceramic’s official quickstart.
In order to get the required package installed, run the following in your Terminal