feat: add README, LICENSE, CONTRIBUTING

2026-06-07 07:55:16 +02:00 · 2025-09-09 20:58:52 +05:30 · 2025-09-09 20:58:52 +05:30 · 957cdcf363
commit 957cdcf363
parent d28991fc60
4 changed files with 247 additions and 1 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -0,0 +1,64 @@
+# Contributing to Dograh AI
+
+First off — thank you for considering contributing! 🎉  
+Dograh AI is open source because we believe the future of voice AI should stay in the hands of developers and the community.  
+
+For now, this guide will get you started. Future documentation will be more comprehensive and is under progress.  
+👉 Join us → [Dograh Community Slack](https://join.slack.com/t/dograh-community/shared_invite/zt-3czr47sw5-MSg1J0kJ7IMPOCHF~03auQ)
+
+
+
+## 🙌 How You Can Contribute
+
+- 🐛 **Report bugs** via GitHub Issues  
+- 💡 **Suggest features**  
+- 🔧 **Submit pull requests**  
+- 📖 **Improve documentation** — even fixing typos helps!  
+- 💬 **Join the Slack community** — the cornerstone of our collaboration  
+
+
+
+## 🧰 Issue Types
+
+On our [GitHub Issues page](../../issues), you’ll find these categories:  
+
+- 📄 **Documentation change request**  
+- ✨ **Feature request**  
+- 🐞 **Bug report**  
+- ❓ **General questions**  
+- 🔒 **Security vulnerability report**  
+
+👉 A great place to start is with issues tagged **`good first issue`**.  
+
+
+
+## 🛠 Development Guidelines
+
+- Keep PRs focused and scoped.  
+- Follow Python best practices (PEP8).  
+- Please **link the issue** in your PR description using:   fixes #<issue_number>
+
+This auto-closes the issue when merged.  
+
+
+
+## 🚀 Getting Started
+- Fork the repository
+- Create your feature branch (git checkout -b feature/AmazingFeature)
+- Commit your changes (git commit -m 'Add some AmazingFeature')
+- Push to the branch (git push origin feature/AmazingFeature)
+Open a Pull Request 🎉
+
+
+
+## 💬 Community & Contribution Hub
+Our Slack community is not just for support — it’s the cornerstone of Dograh AI contributions. Here, you can:
+- Connect with maintainers and other contributors
+- Discuss issues and features before coding
+- Get help with setup and debugging
+- Stay up to date with contribution sprints
+
+
+👉 Join us → [Dograh Community Slack](https://join.slack.com/t/dograh-community/shared_invite/zt-3czr47sw5-MSg1J0kJ7IMPOCHF~03auQ)
+
+Thank you for helping us keep Dograh AI open and thriving! 💜
--- a/24
+++ b/24
@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2025, Zansat Technologies Private Limited
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
--- a/README.md
+++ b/README.md
@ -0,0 +1,158 @@
+
+
+
+# Dograh AI
+
+
+
+
+<p align="center">
+  <a href="LICENSE">
+    <img src="https://img.shields.io/badge/license-BSD%202--Clause-blue.svg" alt="License: BSD 2-Clause">
+  </a>
+  <a href="https://join.slack.com/t/dograh-community/shared_invite/zt-3czr47sw5-MSg1J0kJ7IMPOCHF~03auQ">
+    <img src="https://img.shields.io/badge/chat-on%20Slack-4A154B?logo=slack" alt="Slack Community">
+  </a>
+  <a href="https://www.docker.com/">
+    <img src="https://img.shields.io/badge/docker-ready-blue?logo=docker" alt="Docker Ready">
+  </a>
+</p>
+
+The fastest way to build voice bots - get started with any voice AI use case in under 2 minutes (our hard SLA standards).
+Build voice agents in just one line or drag-and-drop, then test them using AI personas that mimic real customer calls. It's 100% open source, self-hosted if you want, and never hides a line of code- ever. The project has a strong commitment to **100% open source** and every line of code is released in the open.
+Maintained by YC alumni and exit founders, we're making sure the future of voice AI stays open, not monopolized.
+
+## 🎥 Demo Video
+📺 [Watch 1-min demo video](#) *(coming soon)*
+
+## 🚀 Quickstart
+
+### Prerequisites
+
+To run Dograh AI locally, make sure you have the following installed:
+
+- [Docker](https://docs.docker.com/get-docker/)  
+- [Docker Compose](https://docs.docker.com/compose/install/)  
+- [curl](https://curl.se/download.html) – usually preinstalled on macOS/Linux
+
+
+> **Note**  
+> Make sure Docker Desktop (or your system’s Docker service) is running before you begin.
+
+## 🚀 Get Started
+
+The only commands you need to run:
+
+```bash
+curl -o docker-compose.yml https://raw.githubusercontent.com/Flagsmith/flagsmith/main/docker-compose.yml
+docker-compose -f docker-compose.yml up
+````
+
+> **Note**  
+> Open your browser at http://localhost:3000 and create your first AI voice assistant for the usecase you want!
+ 
+### 🎙️ Your First Voice Bot
+
+1. **Open Dashboard**: Launch [http://localhost:3000](http://localhost:3000) on your browser
+2. **Choose Call Type**: Select **Inbound** or **Outbound** calling.
+3. **Name Your Bot**: Use a short two-word name (e.g., *Lead Qualification*).
+4. **Describe Use Case**: In 5–10 words (e.g., *Screen insurance form submissions for purchase intent*).
+5. **Launch**: Your bot is ready! Open the bot and click **Web Call** to talk to it.
+6. **No API Keys Needed**: We auto-generate Dograh API keys so you can start immediately. You can switch to your own keys anytime.
+7. **Default Access**: Includes Dograh’s own LLMs, STT, and TTS stack by default.
+8. **Bring Your Own Keys**: Optionally connect your own API keys for LLMs, STT, TTS, or telephony providers like Twilio.
+
+## Quick Summary
+⚡ 2-Minute Setup: Hard SLA standards - from zero to working voice bot in under 2 minutes
+- 🔧 Minimal setup: Just [run docker command](#get-started) and you're live 
+- 🤖 AI Testing Personas: Test your bots with LoopTalk AI that mimics real customer interactions
+- 🔓 100% Open Source: Every line of code is open - no hidden logic, no black boxes
+- 🔄 Flexible Integration: Bring your own LLM, TTS, or STT - or use Dograh’s API’s
+- ☁️ Self-Host or Cloud: Run locally or use our hosted version at app.dograh.com
+
+
+##  Features
+### Voice Capabilities
+- Telephony: Built-in Twilio integration (easily add others)
+- Languages: English support (expandable to other languages)
+- Custom Models: Bring your own TTS/STT models
+- Real-time Processing: Low-latency voice interactions
+
+### Developer Experience
+- Zero Config Start: Auto-generated API keys for instant testing
+- Python-Based: Built on Python for easy customization
+- Docker-First: Containerized for consistent deployments
+- Modular Architecture: Swap components as needed
+
+### Testing & Quality
+- LoopTalk (Beta): Create AI personas to test your voice agents
+- Workflow Testing: Test specific workflow IDs with automated calls
+- Real-world Simulation: AI personas that mimic actual customer behavior
+
+## Configuration
+Dograh automatically generates API keys on first run, but you can use your own keys. 
+  - OPENAI_API_KEY=your_key_here
+  - TWILIO_ACCOUNT_SID=your_sid_here
+  - TWILIO_AUTH_TOKEN=your_token_here
+
+## Architecture
+Architecture diagram  *(coming soon)* 
+
+## Deployment Options
+### Local Development
+Refer [prerequisites](#Prerequisites) and [first steps](#get-started)
+
+### Production (Self-Hosted)
+Production guide coming soon. [Drop in a message](https://join.slack.com/t/dograh-community/shared_invite/zt-3czr47sw5-MSg1J0kJ7IMPOCHF~03auQ) for assistance.
+
+### Cloud Version
+Visit [https://www.dograh.com](https://www.dograh.com/) for our managed cloud offering.
+
+## 📚Documentation
+Full documentation is in progress. For now, this README will get you started.
+
+##  🤝Community & Support
+- GitHub Issues: Report bugs or request features
+- Slack: Our Slack community is not just for support — it’s the cornerstone of Dograh AI contributions. Here, you can:
+  - Connect with maintainers and other contributors
+  - Discuss issues and features before coding
+  - Get help with setup and debugging
+  - Stay up to date with contribution sprints
+
+
+👉 Join us → Dograh Community Slack
+## Tech Stack
+- FastAPI
+- Pipecat
+- LiveKit
+- PostgreSQL
+- Next.js
+- XYFlow React
+- Inbuilt Twilio integration
+- Flexible back-end: switch to any LLM, TTS, or STT
+
+## 🙌 Contributing
+We love contributions! Dograh AI is 100% open source and we intend to keep it that way.
+
+### Getting Started
+- Fork the repository
+- Create your feature branch (git checkout -b feature/AmazingFeature)
+- Commit your changes (git commit -m 'Add some AmazingFeature')
+- Push to the branch (git push origin feature/AmazingFeature)
+- Open a Pull Request
+
+## 📄 License
+Dograh AI is licensed under the [BSD 2-Clause License](LICENSE)- the same license as projects that were used in building Dograh AI, ensuring compatibility and freedom to use, modify, and distribute.
+
+## 🏢 About
+Built with ❤️ by **Dograh** (Zansat Technologies Private Limited)
+Founded by YC alumni and exit founders committed to keeping voice AI open and accessible to everyone.
+
+<br><br><br>
+
+<p align="center">
+  <a href="https://github.com/dograh-hq/dograh/stargazers">⭐ Star us on GitHub</a> |
+  <a href="https://www.dograh.com">☁️ Try Cloud Version</a> |
+  <a href="https://join.slack.com/t/dograh-community/shared_invite/zt-3czr47sw5-MSg1J0kJ7IMPOCHF~03auQ">💬 Join Slack</a>
+</p>
+
--- a/docker-compose.yaml
+++ b/docker-compose.yaml
@ -173,7 +173,7 @@ services:
      NEXT_PUBLIC_AUTH_PROVIDER: "local"
      # Client-side URL (from browser)
      NEXT_PUBLIC_BACKEND_URL: "http://localhost:8000"
-      # Server-side URL (SSR, internal Docker network)p
+      # Server-side URL (SSR, internal Docker network)
      BACKEND_URL: "http://api:8000"

      # Posthog