Curiosity for Developers
  • Overview
  • Getting Started
    • Introduction
    • System Overview
      • Workspace
      • Connectors
      • Front End
    • Requirements
    • Installation
      • Deploying on Windows
        • Download Curiosity Workspace for Windows
      • Deploying on Docker
        • Deploying using Docker Desktop App
        • Docker Hub
      • Deploying on Kubernetes
      • Deploying on OpenShift
      • Configuration
    • Configure your Workspace
    • Connecting to a Workspace
      • Download App
    • Built-in Templates
  • Security
    • Introduction
    • Hosting
    • Encryption
    • Users and Access
      • User Invitations
      • Single Sign-On (SSO)
        • Google Sign-In
        • Microsoft / Azure AD
        • Okta
        • Auth0
    • Permissions Management
    • Auditing
    • Teams management
    • Configuring Backup
      • Restoring a backup
    • Activate a workspace license
  • Data Sources
    • Introduction
    • User Apps
    • Workspace Integrations
    • API Integrations
      • Introduction
      • Data Modeling
      • Writing a Connector
      • Access Control
      • API Tokens
      • API Overview
      • Tips
    • Supported File Types
    • Curiosity CLI
      • Installation
      • Authentication
      • Commands
  • Search
    • Introduction
    • Languages
    • Synonyms
    • Ranking
    • Filters
    • Search Permissions and Access Control
  • Endpoints
    • Introduction
    • Creating an endpoint
    • Calling an endpoint
    • Endpoint Tokens
    • Endpoints API
  • Interfaces
    • Introduction
    • Local Development
    • Deploying a new interface
    • Routing
    • Node Renderers
    • Sidebar
    • Views
  • Artificial Intelligence
    • Introduction
    • Embeddings Search
    • AI Assistant
      • Enabling AI Assistant
    • Large Language Models
      • LLMs Models Configuration
      • Self-Hosted Models
    • Image Search
    • Audio and Video Search
  • Sample Workspaces
    • Introduction
    • HackerNews
    • Aviation Incidents
    • Covid Papers
    • NASA Public Library
    • Suggest a Recipe
  • Basic Concepts
    • Graph database
    • Search Engine
  • Troubleshooting
    • FAQs
      • How long does it take to set up?
      • How does Curiosity keep my data safe?
      • Can we get Curiosity on-premises?
      • Can I connect custom data?
      • How does Workspace pricing work?
      • Which LLM does Curiosity use?
      • What's special about Curiosity?
      • How are access permissions handled?
      • What enterprise tools can I connect?
      • How to access a workspace?
      • How do I hard refresh my browser?
      • How do I report bugs?
      • How do I solve connectivity issues?
      • How do I contact support?
  • Policies
    • Terms of Service
    • Privacy Policy
Powered by GitBook
On this page
  1. Getting Started

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.

PreviousFront EndNextInstallation

Last updated 1 year ago

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 .

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

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

  • 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 , 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 . 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 as an alternative, and for macOS, either Visual Studio Code or ).

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

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 .

here
here
here
here
here
here
Visual Studio Code
Visual Studio for Mac
Windows installer
Docker
Kubernetes
OpenShift
https://github.com/curiosity-ai/