{"id":25973392,"url":"https://github.com/samzhangjy/observerx","last_synced_at":"2025-10-03T23:53:35.707Z","repository":{"id":186920894,"uuid":"664987501","full_name":"samzhangjy/ObserverX","owner":"samzhangjy","description":"🤖️ Node.js framework for instantly building GPT bot applications.","archived":false,"fork":false,"pushed_at":"2023-08-30T08:28:10.000Z","size":17741,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-07T16:51:43.906Z","etag":null,"topics":["bot","bot-framework","chatgpt","framework","gpt","gpt-3","gpt-4","gpt-api","javascript","nodejs","typescript"],"latest_commit_sha":null,"homepage":"https://observerx.samzhangjy.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/samzhangjy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-11T07:33:54.000Z","updated_at":"2024-07-06T02:31:58.000Z","dependencies_parsed_at":"2025-03-05T01:30:22.579Z","dependency_job_id":"6235334d-c3bb-472e-9362-5cdda664e74d","html_url":"https://github.com/samzhangjy/ObserverX","commit_stats":null,"previous_names":["samzhangjy/observerx"],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/samzhangjy/ObserverX","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samzhangjy%2FObserverX","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samzhangjy%2FObserverX/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samzhangjy%2FObserverX/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samzhangjy%2FObserverX/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/samzhangjy","download_url":"https://codeload.github.com/samzhangjy/ObserverX/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/samzhangjy%2FObserverX/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278245377,"owners_count":25955014,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-03T02:00:06.070Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","bot-framework","chatgpt","framework","gpt","gpt-3","gpt-4","gpt-api","javascript","nodejs","typescript"],"created_at":"2025-03-05T01:29:33.427Z","updated_at":"2025-10-03T23:53:35.675Z","avatar_url":"https://github.com/samzhangjy.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 --\u003e\n\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\u003c!--\n*** Thanks for checking out the Best-README-Template. If you have a suggestion\n*** that would make this better, please fork the repo and create a pull request\n*** or simply open an issue with the tag \"enhancement\".\n*** Don't forget to give the project a star!\n*** Thanks again! Now go create something AMAZING! :D\n--\u003e\n\n![banner](assets/banner.jpg)\n\n\u003c!-- PROJECT SHIELDS --\u003e\n\u003c!--\n*** I'm using markdown \"reference style\" links for readability.\n*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).\n*** See the bottom of this document for the declaration of the reference variables\n*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.\n*** https://www.markdownguide.org/basic-syntax/#reference-style-links\n--\u003e\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n\n\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/samzhangjy/ObserverX\"\u003e\n    \u003cimg src=\"assets/logo.png\" alt=\"ObserverX\" width=\"80\" height=\"80\"\u003e\n  \u003c/a\u003e\n\n\u003ch3 align=\"center\"\u003eObserverX\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    Your AI mate.\n    \u003cbr /\u003e\n    \u003ca href=\"https://observerx.samzhangjy.com/\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/samzhangjy/ObserverX\"\u003eView Demo\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/samzhangjy/ObserverX/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/samzhangjy/ObserverX/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\nObserverX is a bot framework bundled with various builtin features, including:\n\n- Dynamic database loading\n- Instant history search for bot\n- Ready-to-deploy admin panel\n- Multiple deployable platforms\n- Fully customizable\n\nObserverX is currently built on top of GPT-3.5 / GPT-4's `function` API and may support other\nbots in the future.\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\nFollow the steps below to start a console session with the bot.\n\n### Prerequisites\n\n- Node.js 18.17.1 or higher\n\n### Installation\n\n1. Get an OpenAI API key at \u003chttps://platform.openai.com/account/api-keys\u003e.\n2. Install ObserverX\n   ```sh\n   npm install @observerx/core @observerx/console @observerx/database @observerx/plugin-default\n   ```\n3. Create `index.js` and fill in the following content:\n   ```js\n   import PlatformConsole from '@observerx/console';\n   import { addEntities, getDataSource } from '@observerx/database';\n   import ObserverX from '@observerx/core';\n   import pluginDefault from '@observerx/plugin-default';\n\n   addEntities(...ObserverX.getDatabaseEntities());\n   const dataSource = getDataSource();\n   \n   await dataSource.initialize();\n\n   const platform = new PlatformConsole(dataSource);\n\n   platform.start({\n     model: 'GPT-3.5',\n     parentId: 'CONSOLE',\n     prompt: 'default',\n     plugins: [pluginDefault],\n   });\n   ```\n4. Create `.env` in the same folder as `index.js` and fill in the following content:\n   ```properties\n   OPENAI_API_KEY=\u003cyour api key\u003e\n   OPENAI_BASE_PATH=\u003coptional, remove this if you don't need to change\u003e\n    \n   DATABASE_HOST=\u003cdatabase host\u003e\n   DATABASE_USERNAME=\u003cdatabase username\u003e\n   DATABASE_PASSWORD=\u003cdatabase password\u003e\n   DATABASE_NAME=\u003cdatabase name\u003e\n   DATABASE_PORT=\u003cdatabase port\u003e\n   ```\n   Note that you **must** use Postgres as the database.\n5. Run `index.js`:\n   ```sh\n   node index.js\n   ```\n   ...and you're ready to go!\n\n\n\u003c!-- ROADMAP --\u003e\n## Roadmap\n\nSee the [open issues](https://github.com/samzhangjy/ObserverX/issues) for a full list of proposed features (and known issues).\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nYou can contribute to ObserverX by [opening an issue](https://github.com/samzhangjy/ObserverX/issues) or [starting a pull request](https://github.com/samzhangjy/ObserverX/pulls)\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/samzhangjy/ObserverX.svg?style=for-the-badge\n[contributors-url]: https://github.com/samzhangjy/ObserverX/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/samzhangjy/ObserverX.svg?style=for-the-badge\n[forks-url]: https://github.com/samzhangjy/ObserverX/network/members\n[stars-shield]: https://img.shields.io/github/stars/samzhangjy/ObserverX.svg?style=for-the-badge\n[stars-url]: https://github.com/samzhangjy/ObserverX/stargazers\n[issues-shield]: https://img.shields.io/github/issues/samzhangjy/ObserverX.svg?style=for-the-badge\n[issues-url]: https://github.com/samzhangjy/ObserverX/issues\n[license-shield]: https://img.shields.io/github/license/samzhangjy/ObserverX.svg?style=for-the-badge\n[license-url]: https://github.com/samzhangjy/ObserverX/blob/main/LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamzhangjy%2Fobserverx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamzhangjy%2Fobserverx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamzhangjy%2Fobserverx/lists"}