structure ready

Author: Coder-Xylem

.github/workflows/deploy-backend.yml

@@ -0,0 +1,27 @@
+
+---
+
+### MIT License file (`LICENSE`)
+
+```txt
+MIT License
+
+Copyright (c) 2025 Abdullah Shaikh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

.github/workflows/deploy-client.yml

@@ -0,0 +1,186 @@
+
+
+
+# Zuno - AI Powered Chatbot
+
+Welcome to **Zuno**, an AI-powered chatbot platform designed to deliver intelligent conversational experiences by combining advanced AI, vector search databases, and cloud infrastructure.
+
+---
+
+## Table of Contents
+
+- [Project Overview](#project-overview)
+- [Features](#features)
+- [Architecture & Folder Structure](#architecture--folder-structure)
+- [Setup & Installation](#setup--installation)
+- [Environment Variables](#environment-variables)
+- [Running the Project](#running-the-project)
+  - [Backend (AWS)](#backend-aws)
+  - [Frontend (Client)](#frontend-client)
+- [Deployment](#deployment)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contact](#contact)
+
+---
+
+## Project Overview
+
+Zuno is a full-stack AI chatbot platform featuring:
+
+- **Backend API**: Hosted on AWS, containing microservices for AI pipelines, authentication, billing, project management, and web scraping.
+- **Frontend client**: Built with TypeScript and React/Next.js, providing a responsive UI for user interactions and management.
+- Integration with vector search databases like Pinecone and Weaviate to enhance chatbot intelligence.
+- CI/CD automation with GitHub Actions and Vercel for seamless deployment.
+
+---
+
+## Features
+
+- Advanced AI chatbot powered by custom AI pipelines.
+- User authentication and secure session handling.
+- Subscription and billing management.
+- Project creation and chatbot management dashboards.
+- Automated scraping for dynamic content updates.
+- Environment-specific configuration.
+- Automated deployment workflows.
+
+---
+
+## Architecture & Folder Structure
+
+```
+
+zuno/
+├── aws/                    # Backend API microservices (Node.js)
+│   ├── controllers/        # API controllers
+│   ├── routes/             # API routes
+│   ├── middleware/         # Express middleware
+│   ├── ai/                 # AI pipeline code
+│   ├── utils/              # Utilities (logging, error handling)
+│   ├── scraping/           # Scraper scripts
+│   ├── vectorstore/        # Pinecone & Weaviate integration
+│   ├── package.json
+│   ├── .env                # Backend environment variables (excluded from git)
+│   └── main.js             # Entry point
+├── client/                 # Frontend client apps
+│   ├── sdk/                # SDK or helper libs for frontend
+│   ├── zuno-frontend/      # Main frontend Next.js app
+│   ├── .env                # Frontend env vars (excluded from git)
+│   ├── package.json
+│   └── vite.config.ts
+├── docs/                   # Documentation & diagrams
+├── scripts/                # Deployment and utility scripts
+├── .github/                # GitHub workflows for CI/CD
+├── .gitignore              # Git ignore rules
+├── package.json            # Root package.json (if needed)
+└── README.md               # This file
+
+````
+
+---
+
+## Setup & Installation
+
+### Prerequisites
+
+- Node.js (v16+)
+- npm or yarn
+- AWS CLI configured for backend deployment
+- Vercel account for frontend hosting
+- Access to Pinecone/Weaviate (API keys)
+
+### Installation Steps
+
+1. **Clone the repo**
+
+```bash
+git clone https://github.com/Coder-Philosopher/zuno.git
+cd zuno
+````
+
+2. **Install backend dependencies**
+
+```bash
+cd aws
+npm install
+```
+
+3. **Install frontend dependencies**
+
+```bash
+cd ../client/sdk
+npm install
+
+cd ../zuno-frontend
+npm install
+```
+
+---
+
+## Environment Variables
+
+Create `.env` files in these locations (add your secrets, never commit):
+
+* `aws/.env`: AWS credentials, DB URLs, API keys, JWT secrets
+* `client/sdk/.env`: SDK-specific configs (if any)
+* `client/zuno-frontend/.env`: Frontend environment vars like API endpoints, public keys
+
+---
+
+## Running the Project
+
+### Backend (AWS)
+
+Start backend API locally:
+
+```bash
+cd aws
+npm run dev
+```
+
+### Frontend (Client)
+
+Start frontend app locally:
+
+```bash
+cd client/zuno-frontend
+npm run dev
+```
+
+---
+
+## Deployment
+
+* **Backend**: Use the `scripts/deploy-backend.sh` script or CI/CD pipeline to deploy on AWS.
+* **Frontend**: Connect GitHub repo to Vercel and configure environment variables in Vercel dashboard. Deployment happens automatically on push.
+* GitHub workflows automate testing and deployment under `.github/workflows`.
+
+---
+
+## Contributing
+
+Contributions welcome!
+
+* Fork the repo
+* Create feature branch
+* Run tests & lint code
+* Submit a pull request with detailed description
+
+---
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+## Contact
+
+**Abdullah Shaikh**
+GitHub: [Coder-Philosopher](https://github.com/Coder-Philosopher)\
+X (Twitter): [@abdsbit](https://x.com/abdsbit)\
+Email: [abdullahsknitrr@gmail.com](mailto:abdullahsknitrr@gmail.com)\
+Project Repository: [https://github.com/Coder-Philosopher/zuno](https://github.com/Coder-Philosopher/zuno)
+
+