Skip to content

gitana/sdk

Repository files navigation

Gitana SDK

Welcome to the Gitana SDK.

This repository contains deployment scripts, sample code, demos and other facilities to help you getting started using the Gitana platform.

Gitana Platform

Gitana lets you curate, preview and approve insightful knowledge for training, validation and scheduled release to the Foundation Models, private LLMs, vector DBs and API services that support your live customers.

The platform streamlines the following:

  • Raw data comes in.
  • Editorial and approval teams curate that data into knowledge alongside automated experts.
  • That knowledge is taught to foundation models, smart API endpoints and LLMs.
  • Once everything is trained up and ready to go, the release goes on-time as scheduled.

The Gitana platform is available as both a cloud-hosted service and self-managed containers. This allows customers to own their data, maintain private LLMs and Foundation Models and never cede their informational competitive advantage.

For more information or to get started, please visit:

https://gitana.io/

Contents

Code Samples

The code-samples directory contains samples of how to use our various drivers, REST APIs and middleware components within your own applications. These should serve as a basis and a reference for building your own applications.

Containers

The containers directory contains guides and source configurations to help self-managed or on-premise users with deploying Gitana into various container frameworks, including Kubernetes, Amazon ECS and others.

There are examples here for both Gitana 3.2 and Gitana 4.0.

HTTP Deployment Receiver

The http-deployment-receiver directory contains a sample Node.js-based deployment receiver that you can instantiate to get an idea of how to handle your own deployments. Content is sent to your listener and you can use this to potentially update a local database, invalidate cache, populate a search index or more.

Packager

The packager directory contains examples how to use our ETL (Extract, Transform, Load) tool to consume data from external sources (such as databases, email or file systems) and store that content into Gitana.

UI Extensions

The ui-extensions directory contains sample modules, form components and theme extensions that can be applied to the Gitana User Interface (both in the cloud and self-managed) to change the user interface and/or introduce new functionality.

UI Frameworks

The ui-frameworks directory contains samples of how to utilize the Gitana APIs from within various frontend UI frameworks such as Next.js, Nuxt, React and others).

Web Hook Server

The webhook-server directory contains a sample Node.js-based Web Hook server that you can run to get an idea of how to handle web hooks that are triggered by Gitana's event system. You can use this to potentially update a local DB, perform cache invalidation or fire off custom logic as per your needs.

Drivers

Gitana provides drivers for specific languages that help you to get started building awesome things. For guidance on these drivers, please see:

Gitana - C# Driver Gitana - Go Driver Gitana - Java Driver Gitana - JavaScript Driver Gitana - PHP Driver Gitana - Python Driver Gitana - Ruby Driver

Cookbooks

As you learn about Gitana, the following cookbooks offer useful guides on various topics:

Gitana - Content Modeling Cookbook Gitana - C# Cookbook Gitana - Go Cookbook Gitana - Java Cookbook Gitana - JavaScript Cookbook Gitana - Node.js Cookbook Gitana - PHP Cookbook Gitana - Python Cookbook Gitana - REST API Cookbook Gitana - Ruby Cookbook Gitana - Scripting Cookbook

UI Frameworks

We provide some examples of writing code in modern UI frameworks (such as Next.js) that connect to the Gitana API and surface content.

Gitana - AngularJS Guide Gitana - cURL Guide Gitana - Gatsby Guide Gitana - Next.js Guide Gitana - Nuxt.js Guide Gitana - Postman Guide Gitana - React Guide Gitana - SvelteKit Guide Gitana - Vue.js Guide

License

Everything in this SDK is licensed under the Apache 2.0 license. You are free to be inspired or utilize anything from this repository within your own projects. Everything here is provided as is and is not supported by Gitana or any external parties.

For more information, please review the provided Apache 2.0 License

Questions

If you have any questions, please reach out to Gitana's support org at support@gitana.io.

Enjoy!