Skip to content

Commit

Permalink
Changing name to KaibanJS. (#55)
Browse files Browse the repository at this point in the history
  • Loading branch information
darielnoel authored Aug 31, 2024
2 parents 0063d7d + 9798b28 commit 078ccab
Show file tree
Hide file tree
Showing 62 changed files with 161 additions and 161 deletions.
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Bug report
about: Create a bug report for AgenticJS
about: Create a bug report for KaibanJS
title: "[BUG] - Bug title here"
labels: bug
assignees: ''
Expand All @@ -10,8 +10,8 @@ assignees: ''
### Describe the Bug
A clear and concise description of what the bug is.

### AgenticJS Team Config
Provide a link to a playground or configuration file to reproduce the issue in your AgenticJS setup, if applicable. For example, see: [Example Playground](https://www.agenticjs.com/share/v0EdWee1mYpzlv6KeuLG)
### KaibanJS Team Config
Provide a link to a playground or configuration file to reproduce the issue in your KaibanJS setup, if applicable. For example, see: [Example Playground](https://www.kaibanjs.com/share/v0EdWee1mYpzlv6KeuLG)

### Steps to Reproduce
A step-by-step description of how to reproduce the issue, based on the linked reproduction. Screenshots can be provided.
Expand All @@ -21,5 +21,5 @@ A clear and concise description of what the bug is, and what you expected to hap

### Environment
- Framework/Library: [e.g., React, Vue, NodeJS, Vanilla JavaScript]
- AgenticJS Version: [e.g., 0.1.0]
- KaibanJS Version: [e.g., 0.1.0]
- JavaScript Runtime: [e.g., Chrome, NodeJS]
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/doc_issue.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Doc Issue Report
about: Create a doc issue report for AgenticJS documentation
about: Create a doc issue report for KaibanJS documentation
title: "[DOC ISSUE] - Issue title here"
labels: documentation
assignees: ''
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/websiteAgenticJS_bug_report.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Website Issue Report
about: Create a report to help us improve the AgenticJS website
about: Create a report to help us improve the KaibanJS website
title: "[WEBSITE ISSUE] - Brief description of the issue"
labels: website, bug
assignees: ''
Expand Down
36 changes: 18 additions & 18 deletions .github/workflows/ci-environment-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,48 +10,48 @@ jobs:
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
VITE_OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
steps:
- name: Checkout AgenticJS Library
- name: Checkout KaibanJS Library
uses: actions/checkout@v2
with:
repository: AI-Champions/AgenticJS
path: agenticjs
repository: kaiban-ai/KaibanJS
path: kaibanjs

- name: Checkout AgenticJS-React-Vite Repository
- name: Checkout KaibanJS-React-Vite Repository
uses: actions/checkout@v2
with:
repository: darielnoel/AgenticJS-React-Vite
repository: darielnoel/KaibanJS-React-Vite
token: ${{ secrets.GITHUB_TOKEN }} # This is needed to access the repository
path: react-vite-app

- name: Checkout AgenticJS-NodeJS Repository
- name: Checkout KaibanJS-NodeJS Repository
uses: actions/checkout@v2
with:
repository: darielnoel/AgenticJS-NodeJS
repository: darielnoel/KaibanJS-NodeJS
token: ${{ secrets.GITHUB_TOKEN }} # This is needed to access the repository
path: agenticjs-nodejs
path: kaibanjs-nodejs

- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: 18.x

- name: Build and Pack AgenticJS Library
- name: Build and Pack KaibanJS Library
run: |
cd agenticjs
cd kaibanjs
npm install
npm run build
npm pack
id: agenticjs-build
id: kaibanjs-build

- name: Install other dependencies for React + Vite App
run: |
cd react-vite-app
npm install
- name: Install AgenticJS in React + Vite App using Pack
- name: Install KaibanJS in React + Vite App using Pack
run: |
cd react-vite-app
npm install ../agenticjs/*.tgz
npm install ../kaibanjs/*.tgz
- name: Build React + Vite App
run: |
Expand All @@ -66,15 +66,15 @@ jobs:
# Handle NodeJS App after React + Vite App
- name: Install other dependencies for NodeJS App
run: |
cd agenticjs-nodejs
cd kaibanjs-nodejs
npm install
- name: Install AgenticJS in NodeJS App using Pack
- name: Install KaibanJS in NodeJS App using Pack
run: |
cd agenticjs-nodejs
npm install ../agenticjs/*.tgz
cd kaibanjs-nodejs
npm install ../kaibanjs/*.tgz
- name: Test NodeJS App
run: |
cd agenticjs-nodejs
cd kaibanjs-nodejs
npm test
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## Contributing to AgenticJS
## Contributing to KaibanJS

We appreciate your interest in contributing to AgenticJS! Here are a few guidelines to help you get started:
We appreciate your interest in contributing to KaibanJS! Here are a few guidelines to help you get started:

### How to Contribute

1. **Explore Issues**: Start by looking through the [issues](https://github.com/AI-Champions/AgenticJS/issues) on GitHub. Pick an issue that interests you, and please check if it has the **"in progress"** label, which means someone is already working on it. If you have a new idea or have found a bug, feel free to submit a new issue. Ensure the issue you choose is not already being worked on by someone else.
1. **Explore Issues**: Start by looking through the [issues](https://github.com/kaiban-ai/KaibanJS/issues) on GitHub. Pick an issue that interests you, and please check if it has the **"in progress"** label, which means someone is already working on it. If you have a new idea or have found a bug, feel free to submit a new issue. Ensure the issue you choose is not already being worked on by someone else.

2. **Fork and Clone**: Fork the AgenticJS repository and then clone your fork. This will set you up with a local version of the project to work on.
2. **Fork and Clone**: Fork the KaibanJS repository and then clone your fork. This will set you up with a local version of the project to work on.

3. **Branch Creation**: Create a new branch in your local repository. It helps to name your branch in a way that reflects the work you're doing. For example, `feature/add-new-agent` or `bugfix/resolve-dependency-issue`.

Expand All @@ -18,15 +18,15 @@ We appreciate your interest in contributing to AgenticJS! Here are a few guideli

7. **Commit Messages**: Write clear and concise commit messages, describing what has changed and why.

8. **Pull Request**: Push your changes to your fork and submit a pull request to the main AgenticJS repository. Provide a clear description of the problem and solution, including any relevant issue numbers.
8. **Pull Request**: Push your changes to your fork and submit a pull request to the main KaibanJS repository. Provide a clear description of the problem and solution, including any relevant issue numbers.

9. **Code Review**: Wait for the code review process. The community or maintainers will review your pull request. Engage in the conversation and make any requested changes. This collaboration greatly increases the chances that your pull request will be accepted.

10. **Stay Updated**: Keep your pull request updated with the main branch, especially if other changes that might affect your contribution are merged.

### Community Guidelines

We're committed to providing a welcoming and inspiring community for all. Everyone participating in the AgenticJS project—including the codebase and issue tracker—is expected to follow our community guidelines:
We're committed to providing a welcoming and inspiring community for all. Everyone participating in the KaibanJS project—including the codebase and issue tracker—is expected to follow our community guidelines:

- Be respectful of different viewpoints and experiences.
- Gracefully accept constructive criticism.
Expand Down
70 changes: 35 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,43 @@
![AgenticJS Logo](https://www.agenticjs.com/logo.svg)
![KaibanJS Logo](https://res.cloudinary.com/dnno8pxyy/image/upload/v1724534418/KaibanJS_m0s65j.png)

[![Star on GitHub](https://img.shields.io/github/stars/AI-Champions/agenticjs.svg?style=social)](https://github.com/AI-Champions/AgenticJS)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/AI-Champions/agenticjs/blob/main/LICENSE) [![npm version](https://img.shields.io/npm/v/agenticjs.svg?style=flat)](https://www.npmjs.com/package/agenticjs)
[![Star on GitHub](https://img.shields.io/github/stars/kaiban-ai/kaibanjs.svg?style=social)](https://github.com/kaiban-ai/KaibanJS)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/kaiban-ai/kaibanjs/blob/main/LICENSE) [![npm version](https://img.shields.io/npm/v/kaibanjs.svg?style=flat)](https://www.npmjs.com/package/kaibanjs)
[![stability-beta](https://img.shields.io/badge/stability-beta-33bbff.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#beta)
[![Tests](https://github.com/AI-Champions/AgenticJS/actions/workflows/stable-main-check-workflow.yml/badge.svg)](https://github.com/AI-Champions/AgenticJS/actions/workflows/stable-main-check-workflow.yml)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/AI-Champions/AgenticJS/pulls)
[![Tests](https://github.com/kaiban-ai/KaibanJS/actions/workflows/stable-main-check-workflow.yml/badge.svg)](https://github.com/kaiban-ai/KaibanJS/actions/workflows/stable-main-check-workflow.yml)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/kaiban-ai/KaibanJS/pulls)

# AgenticJS
AgenticJS is a JavaScript-native framework for building multi-agent AI systems.
# KaibanJS
KaibanJS is a JavaScript-native framework for building multi-agent AI systems.

## Try It Out

[Explore the Playground](https://www.agenticjs.com/playground)*it's like Trello or Asana, but for AI Agents and humans.*
[Explore the Playground](https://www.kaibanjs.com/playground)*it's like Trello or Asana, but for AI Agents and humans.*

## Getting Started

### Install AgenticJS via npm:
### Install KaibanJS via npm:

```bash
npm install agenticjs
npm install kaibanjs
```

### Import AgenticJS in your JavaScript file:
### Import KaibanJS in your JavaScript file:

```js
// Using ES6 import syntax for NextJS, React, etc.
import { Agent, Task, Team } from 'agenticjs';
import { Agent, Task, Team } from 'kaibanjs';
```

```js
// Using CommonJS syntax for NodeJS
const { Agent, Task, Team } = require("agenticjs");
const { Agent, Task, Team } = require("kaibanjs");
```

> Note: AgenticJS is TypeScript-supported. To learn more, check out the [NodeJS TypeScript example](https://github.com/AI-Champions/AgenticJS/blob/main/playground/nodejs-ts/README.md).
> Note: KaibanJS is TypeScript-supported. To learn more, check out the [NodeJS TypeScript example](https://github.com/kaiban-ai/KaibanJS/blob/main/playground/nodejs-ts/README.md).
## Example Usage

In this example, we use AgenticJS to build a resume generation team. If you're looking to create or update your resume, this setup utilizes specialized AI agents to automatically process your information and produce a polished, professional resume tailored to your career goals.
In this example, we use KaibanJS to build a resume generation team. If you're looking to create or update your resume, this setup utilizes specialized AI agents to automatically process your information and produce a polished, professional resume tailored to your career goals.

```js

Expand Down Expand Up @@ -141,7 +141,7 @@ In this example, our software development team is powered by three specialized A
</p>

```js
import { Agent } from 'agenticjs';
import { Agent } from 'kaibanjs';

const daveLoper = new Agent({
name: 'Dave Loper',
Expand Down Expand Up @@ -178,7 +178,7 @@ In this example, one of the AI agents, Peter Atlas, leverages the Tavily Search
</p>

```js
import { Agent, Tool } from 'agenticjs';
import { Agent, Tool } from 'kaibanjs';

const tavilySearchResults = new Tool({
name: 'Tavily Search Results',
Expand All @@ -195,7 +195,7 @@ const peterAtlas = new Agent({
});
```

*AgenticJS supports all LangchainJS-compatible tools, offering a versatile approach to tool integration. For further details, visit the [documentation](https://github.com/AI-Champions/AgenticJS).*
*KaibanJS supports all LangchainJS-compatible tools, offering a versatile approach to tool integration. For further details, visit the [documentation](https://github.com/kaiban-ai/KaibanJS).*
</details>


Expand All @@ -209,7 +209,7 @@ In this example, the agents—Emma, Lucas, and Mia—use diverse AI models to ha
</p>

```js
import { Agent } from 'agenticjs';
import { Agent } from 'kaibanjs';

const emma = new Agent({
name: 'Emma',
Expand Down Expand Up @@ -242,22 +242,22 @@ const mia = new Agent({
});
```

*For further details on integrating diverse AI models with AgenticJS, please visit the [documentation](https://github.com/AI-Champions/AgenticJS).*
*For further details on integrating diverse AI models with KaibanJS, please visit the [documentation](https://github.com/kaiban-ai/KaibanJS).*
</details>

<details style="margin-bottom:10px;">
<summary><b style="color:black;">Robust State Management</b></summary>

<p style="margin-top:10px;">
AgenticJS employs a Redux-inspired architecture, enabling a unified approach to manage the states of AI agents, tasks, and overall flow within your applications. This method ensures consistent state management across complex agent interactions, providing enhanced clarity and control.
KaibanJS employs a Redux-inspired architecture, enabling a unified approach to manage the states of AI agents, tasks, and overall flow within your applications. This method ensures consistent state management across complex agent interactions, providing enhanced clarity and control.

Here's a simplified example demonstrating how to integrate AgenticJS with state management in a React application:
Here's a simplified example demonstrating how to integrate KaibanJS with state management in a React application:
</p>

```js
import myAgentsTeam from "./agenticTeam";

const AgenticJSComponent = () => {
const KaibanJSComponent = () => {
const useTeamStore = myAgentsTeam.useStore();

const { agents, workflowResult } = useTeamStore(state => ({
Expand All @@ -279,10 +279,10 @@ const AgenticJSComponent = () => {
);
};

export default AgenticJSComponent;
export default KaibanJSComponent;
```

*For a deeper dive into state management with AgenticJS, visit the [documentation](https://github.com/AI-Champions/AgenticJS).*
*For a deeper dive into state management with KaibanJS, visit the [documentation](https://github.com/kaiban-ai/KaibanJS).*
</details>

<details style="margin-bottom:10px;">
Expand All @@ -291,7 +291,7 @@ export default AgenticJSComponent;
<p style="margin-top:10px;">
Easily add AI capabilities to your NextJS, React, Vue, Angular, and Node.js projects.

AgenticJS is designed for seamless integration across a diverse range of JavaScript environments. Whether you’re enhancing user interfaces in React, Vue, or Angular, building scalable applications with NextJS, or implementing server-side solutions in Node.js, the framework integrates smoothly into your existing workflow.
KaibanJS is designed for seamless integration across a diverse range of JavaScript environments. Whether you’re enhancing user interfaces in React, Vue, or Angular, building scalable applications with NextJS, or implementing server-side solutions in Node.js, the framework integrates smoothly into your existing workflow.
</p>

```js
Expand Down Expand Up @@ -324,15 +324,15 @@ const TaskStatusComponent = () => {
export default TaskStatusComponent;
```

*For a deeper dive visit the [documentation](https://github.com/AI-Champions/AgenticJS).*
*For a deeper dive visit the [documentation](https://github.com/kaiban-ai/KaibanJS).*
</details>

</details>
<details style="margin-bottom:10px;">
<summary><b style="color:black;">Observability and Monitoring</b></summary>

<p style="margin-top:10px;">
Built into AgenticJS, the observability features enable you to track every state change with detailed stats and logs, ensuring full transparency and control. This functionality provides real-time insights into token usage, operational costs, and state changes, enhancing system reliability and enabling informed decision-making through comprehensive data visibility.
Built into KaibanJS, the observability features enable you to track every state change with detailed stats and logs, ensuring full transparency and control. This functionality provides real-time insights into token usage, operational costs, and state changes, enhancing system reliability and enabling informed decision-making through comprehensive data visibility.

The following code snippet demonstrates how the state management approach is utilized to monitor and react to changes in workflow logs, providing granular control and deep insights into the operational dynamics of your AI agents:
</p>
Expand Down Expand Up @@ -375,7 +375,7 @@ useStore.subscribe(state => state.workflowLogs, (newLogs, previousLogs) => {
});
```

For more details on how to utilize observability features in AgenticJS, please visit the [documentation](https://github.com/AI-Champions/AgenticJS).
For more details on how to utilize observability features in KaibanJS, please visit the [documentation](https://github.com/kaiban-ai/KaibanJS).
</details>

</details>
Expand All @@ -393,20 +393,20 @@ Kanban boards are excellent tools for showcasing team workflows in real time, pr

## Documentation

- [Official Documentation](https://docs.agenticjs.com/category/core-concepts)
- [Official Documentation](https://docs.kaibanjs.com/category/core-concepts)
- [Join Our Discord](https://bit.ly/JoinAIChamps)

### Compatibility

AgenticJS aims to be compatible with major front-end frameworks like React, Vue, Angular, and NextJS, making it a versatile choice for developers. The JavaScript ecosystem is a "bit complex...". If you have any problems, please tell us and we'll help you fix them.
KaibanJS aims to be compatible with major front-end frameworks like React, Vue, Angular, and NextJS, making it a versatile choice for developers. The JavaScript ecosystem is a "bit complex...". If you have any problems, please tell us and we'll help you fix them.

## Why AgenticJS?
## Why KaibanJS?

There are about 20 million JavaScript developers worldwide, yet most AI frameworks are originally written in Python. Others are mere adaptations for JavaScript.

This puts all of us **JavaScript developers at a disadvantage in the AI race**. But not anymore...

AgenticJS changes the game by aiming to offer a robust, easy-to-use AI multi-agent framework designed specifically for the JavaScript ecosystem.
KaibanJS changes the game by aiming to offer a robust, easy-to-use AI multi-agent framework designed specifically for the JavaScript ecosystem.

```js
const writtenBy = `Another JS Dev Who Doesn't Want to Learn Python to do meaningful AI Stuff.`;
Expand All @@ -419,8 +419,8 @@ Join the [Discord community](https://bit.ly/JoinAIChamps) to connect with other

## Contributing

We welcome contributions from the community. Please read the [contributing guidelines](https://github.com/AI-Champions/AgenticJS/blob/main/CONTRIBUTING.md) before submitting pull requests.
We welcome contributions from the community. Please read the [contributing guidelines](https://github.com/kaiban-ai/KaibanJS/blob/main/CONTRIBUTING.md) before submitting pull requests.

## License

AgenticJS is MIT licensed.
KaibanJS is MIT licensed.
2 changes: 1 addition & 1 deletion jest.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module.exports = {
"^.+\\.[t|j]sx?$": "babel-jest"
},
moduleNameMapper: {
'^agenticjs$': '<rootDir>/dist/bundle.cjs'
'^kaibanjs$': '<rootDir>/dist/bundle.cjs'
},
testTimeout: 300000, // Sets global timeout to 10 seconds for all tests
testEnvironment: 'node', // Use Node.js environment for executing tests,
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 078ccab

Please sign in to comment.