# zkApps Umstad AI Assistant
## Introduction
zkApps Umstad AI Assistant, your expert guide in the world of MINA Protocol, o1js. Designed to assist developers, this chatbot provides in-depth assistance with zkApps o1js which is specifically designed to assist developers working on zkApps development powered by the GPT language model. This project includes two main application:
- **Web Application Chatbot:** zkappsumstad.com
- **CLI Agent:** DOWNLOAD LINK HERE!
# zkApps Umstad Chatbot
## Features
The Umstad AI Assistant offers a comprehensive range of features designed to support developers in various aspects of the MINA Protocol and o1js:
1. **Documentation & General Knowledge:**
- Access to extensive resources including the Mina Protocol documentation, o1js guides, and Auro Wallet information.
- Integration with Mina Book and Mina Blog for up-to-date knowledge and insights.
- Availability of various project documentations to enhance understanding and application.
2. **Example Codebase:**
- Embedded code examples within the documentation for practical reference.
3. **Projects Repositories:**
- Embedded codebase of zkApps projects.
4. **Community Interaction and Issue Tracking:**
- Embedded and processed integration with the Mina Protocol Discord channels, specifically zkapps-developers and zkapps-questions, for community support and engagement.
- Direct access to o1js GitHub Issues, providing insights into current challenges, bugs, and solutions within the community.
5. **Mainnet Blockchain Information Access:**
- Direct access to Blockchain Summary, Block and Account Information utilizing Mina Explorer API.
- Current MINA Price utilizing Coingecko API(TODO: Fix Fetching issue for deployment)
## Best Practices for Asking Questions
1. **Be Specific:** Clearly state your issue or the topic you need assistance with.
2. **Querying issues, errors, problems:** Begin with "I have an issue ..." or "I have a problem ..." for asking about errors, issues, problems, discussion, strange questions etc in order to utilize Issue Tool which queries the Issue Vectors which includes Discord and Github data.
3. **Do not extend the conversation:** Even though `gpt-4-1106-preview` can handle overlong contexts, it is strongly advised that not to extend the conversation too much(For now, ideal 3 questions). Just create new chat after 2-3 questions because every query creates crowded context.
## Technical Details
### Architecture Overview
### Backend Technologies
- **Language and Frameworks:** Built using Next.js functions, OpenAI node.js ensuring robust and scalable performance.
- **Database:** Uses vercel KV db.
- **APIs:** Uses Vercel Functions.
### Security and Compliance
- **Data Privacy:** We store your conversations in the KV db. Do not share confidentials, private keys etc. We are not responsible for Vercel's security.
- **OPENAI API KEY:** Application stores your OpenAI API KEY on the browser local storage. So, if you are using shared computer, please remove your key in the settings panel.
# zkApps Umstad CLI AGENT
TODO
## Features
TODO
## Usage
TODO
### Installation
TODO
### Getting Started
TODO
### Best Practices for Agent
TODO
## Architecture
# Support
For any technical issues or further inquiries, please contact our support team at [berkingurcan@gmail.com](mailto:berkingurcan@gmail.com).
# Acknowledgements
Special thanks to the Mina Protocol zkIgnite program for funding the project and all contributors to this project.
Raw data
{
"_id": null,
"home_page": "https://github.com/UmstadAI/zkAppUmstad/tree/main/cli",
"name": "zkumstad",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "zkapps,zkappumstad,zkapps agent",
"author": "Berkin Gurcan, Dogukan Akar",
"author_email": "berkingurcan@gmail.com, dogukanakarc@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a7/8b/7b6f8c3623c0b2fd4e253c79f2de1ef781513308e85b613249c0ab574b30/zkumstad-0.1.2.tar.gz",
"platform": null,
"description": "# zkApps Umstad AI Assistant\n\n## Introduction\n\nzkApps Umstad AI Assistant, your expert guide in the world of MINA Protocol, o1js. Designed to assist developers, this chatbot provides in-depth assistance with zkApps o1js which is specifically designed to assist developers working on zkApps development powered by the GPT language model. This project includes two main application:\n\n- **Web Application Chatbot:** zkappsumstad.com\n- **CLI Agent:** DOWNLOAD LINK HERE!\n\n# zkApps Umstad Chatbot\n\n## Features\n\nThe Umstad AI Assistant offers a comprehensive range of features designed to support developers in various aspects of the MINA Protocol and o1js:\n\n1. **Documentation & General Knowledge:**\n\n - Access to extensive resources including the Mina Protocol documentation, o1js guides, and Auro Wallet information.\n - Integration with Mina Book and Mina Blog for up-to-date knowledge and insights.\n - Availability of various project documentations to enhance understanding and application.\n\n2. **Example Codebase:**\n\n - Embedded code examples within the documentation for practical reference.\n\n3. **Projects Repositories:**\n\n - Embedded codebase of zkApps projects.\n\n4. **Community Interaction and Issue Tracking:**\n\n - Embedded and processed integration with the Mina Protocol Discord channels, specifically zkapps-developers and zkapps-questions, for community support and engagement.\n - Direct access to o1js GitHub Issues, providing insights into current challenges, bugs, and solutions within the community.\n\n5. **Mainnet Blockchain Information Access:**\n - Direct access to Blockchain Summary, Block and Account Information utilizing Mina Explorer API.\n - Current MINA Price utilizing Coingecko API(TODO: Fix Fetching issue for deployment)\n\n## Best Practices for Asking Questions\n\n1. **Be Specific:** Clearly state your issue or the topic you need assistance with.\n\n2. **Querying issues, errors, problems:** Begin with \"I have an issue ...\" or \"I have a problem ...\" for asking about errors, issues, problems, discussion, strange questions etc in order to utilize Issue Tool which queries the Issue Vectors which includes Discord and Github data.\n\n3. **Do not extend the conversation:** Even though `gpt-4-1106-preview` can handle overlong contexts, it is strongly advised that not to extend the conversation too much(For now, ideal 3 questions). Just create new chat after 2-3 questions because every query creates crowded context.\n\n## Technical Details\n\n### Architecture Overview\n\n### Backend Technologies\n\n- **Language and Frameworks:** Built using Next.js functions, OpenAI node.js ensuring robust and scalable performance.\n- **Database:** Uses vercel KV db.\n- **APIs:** Uses Vercel Functions.\n\n### Security and Compliance\n\n- **Data Privacy:** We store your conversations in the KV db. Do not share confidentials, private keys etc. We are not responsible for Vercel's security.\n- **OPENAI API KEY:** Application stores your OpenAI API KEY on the browser local storage. So, if you are using shared computer, please remove your key in the settings panel.\n\n# zkApps Umstad CLI AGENT\n\nTODO\n\n## Features\n\nTODO\n\n## Usage\n\nTODO\n\n### Installation\n\nTODO\n\n### Getting Started\n\nTODO\n\n### Best Practices for Agent\n\nTODO\n\n## Architecture\n\n# Support\n\nFor any technical issues or further inquiries, please contact our support team at [berkingurcan@gmail.com](mailto:berkingurcan@gmail.com).\n\n# Acknowledgements\n\nSpecial thanks to the Mina Protocol zkIgnite program for funding the project and all contributors to this project.\n",
"bugtrack_url": null,
"license": "",
"summary": "CLI AI Agent for zkApps Developers",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/UmstadAI/zkAppUmstad/tree/main/cli"
},
"split_keywords": [
"zkapps",
"zkappumstad",
"zkapps agent"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "807bbfeea83fc41982d67f66eb49bdf72a0266078bb2bf17b3423cc68784280b",
"md5": "9672e286fcfda4a1075b2d2b20dd0043",
"sha256": "5bbccf70fb4c50641fc2f08d4eb692aa5961d915d4ce9dae619a38e655b78cfc"
},
"downloads": -1,
"filename": "zkumstad-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9672e286fcfda4a1075b2d2b20dd0043",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 22365,
"upload_time": "2024-01-09T19:49:45",
"upload_time_iso_8601": "2024-01-09T19:49:45.552029Z",
"url": "https://files.pythonhosted.org/packages/80/7b/bfeea83fc41982d67f66eb49bdf72a0266078bb2bf17b3423cc68784280b/zkumstad-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a78b7b6f8c3623c0b2fd4e253c79f2de1ef781513308e85b613249c0ab574b30",
"md5": "9b4b46f9f2961fe4bfef3420074ba90d",
"sha256": "85460147ce8ce18e9449b53b652859c89c13d4f332be90f56f3979953a772489"
},
"downloads": -1,
"filename": "zkumstad-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "9b4b46f9f2961fe4bfef3420074ba90d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 16527,
"upload_time": "2024-01-09T19:49:47",
"upload_time_iso_8601": "2024-01-09T19:49:47.497425Z",
"url": "https://files.pythonhosted.org/packages/a7/8b/7b6f8c3623c0b2fd4e253c79f2de1ef781513308e85b613249c0ab574b30/zkumstad-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-09 19:49:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "UmstadAI",
"github_project": "zkAppUmstad",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "zkumstad"
}
JSON
