Captn

Welcome to the official repository for the captn SDK, a suite of packages designed to empower developers to create custom applications using the Captain framework. This repository manages the core packages such as @captn/joy, @captn/react, @captn/theme, @captn/utils and create-captain-app.

Overview

The captn SDK is an integral part of the Captain ecosystem, providing developers with the tools and utilities necessary to build advanced, AI-driven applications. These packages are built on top of popular technologies such as Electron, React, and TypeScript to ensure a robust and developer-friendly experience.

Features

Multi-Package Management: Utilizes Lerna for managing multiple packages within a single repository.
Modular Architecture: Each package serves a specific purpose, enabling custom and lightweight application builds.
TypeScript Support: Full TypeScript support to enhance development with strong typing.
Comprehensive Testing: Integrated testing setups using Jest to ensure reliability and stability.

Getting Started

Prerequisites

Node.js (see .nvmrc)
Git

Installation

Clone the repository:

git clone https://github.com/blib-la/captn.git
cd captn

Install dependencies:

npm install

Usage

To start using the packages within your projects, link them locally or use them directly by importing into your project files.

Development

Running Tests

To run tests across all packages:

npm run test

Building

Build all packages:

npm run build

Linting

Check for linting errors:

npm run lint

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

See also the list of contributors who participated in this project.

License

This project is licensed under the AGPL 3.0 License - see the LICENSE file for details.