Requirements

To get started with Curiosity, you need to install a few tools on your machine. This page will guide you through the installation process for developers.

Prerequisites

Before you install Curiosity, make sure you have the following software installed on your machine:

• Docker Desktop: This is required if you want to run Curiosity as a containerized application. You can download Docker Desktop from here.

• Visual Studio: This is required to edit and debug Curiosity projects. You can download the free Visual Studio Community edition from here, or use your existing installation. You can optionally use Visual Studio Code (download here), or any other IDE of your preference.

• .NET SDK: Make sure you've the latest .NET SDK installed from here.

• H5 Compiler: This is required to compile C# code into JavaScript for web development. H5 is used to build the Curiosity interface, and can be used by you to fully customize the final user interface of your Curiosity Workspace. You can install H5 Compiler as a .NET tool from here, or if you already have the .NET SDK installed, with the following command:

dotnet tool update --global h5-compiler

• Curiosity CLI: This is required to interact with Curiosity from the command line. You can install Curiosity CLI as a .NET tool from here. You can also install it using the following command:

dotnet tool update --global Curiosity.CLI

The list of tools above is developers using Windows, but you can build Curiosity data connectors or custom front-ends in any platform. For Linux, you can use Visual Studio Code as an alternative, and for macOS, either Visual Studio Code or Visual Studio for Mac).

Congratulations! You're ready to start developing your custom Curiosity Workspace. You can now check how to deploy Curiosity locally using our Windows installer, or via Docker containers on Docker, Kubernetes or OpenShift.

You can also start exploring our sample projects to understand how to build connectors and customize your front-end to your needs. For more samples on how to use customize Curiosity, please refer to our GitHub repositories at https://github.com/curiosity-ai/.