Initial Commit

Open-sourcing HAI Build - Specif AI

CONTRIBUTING.md

@@ -0,0 +1,67 @@
+# Contributing to Specif AI
+
+We're excited you're interested in contributing to Specif AI! This document outlines the process for contributing to our project. We welcome contributions from everyone, whether you're fixing a typo, improving documentation, or adding a new feature.
+
+## Getting Started
+
+1. Fork the repository on GitHub.
+2. Clone your fork locally:
+   ```
+   git clone https://github.com/presidio-oss/specif-ai
+   cd https://github.com/presidio-oss/specif-ai
+   ```
+3. To set up and run the application locally, follow the guides provided for:
+   - Backend: [Backend setup guide](./backend/README.md)
+   - Electron: [Electron setup guide](./electron/README.md)
+
+## Making Changes
+
+1. Create a new branch for your changes:
+   ```
+   git checkout -b your-branch-name
+   ```
+2. Make your changes in the codebase:
+   - UI Changes: Make your UI code file changes in the `ui/` and `electron/` folders respectively.
+   - Backend Changes: Make backend changes in `backend/` folder.
+3. Write or update tests as necessary.
+4. Format your code.
+5. Run linting checks.
+
+## Submitting Changes
+
+1. Commit your changes:
+   ```
+   git commit -m "Your detailed commit message"
+   ```
+2. Push to your fork:
+   ```
+   git push origin your-branch-name
+   ```
+3. Submit a pull request through the GitHub website to <github url>
+
+## Pull Request Guidelines
+
+- Provide a clear title and description of your changes.
+- Include any relevant issue numbers in the PR description.
+- Ensure all tests pass and there are no linting errors.
+- Update documentation if you're changing functionality.
+
+Before submitting a pull request, verify the changes in your local environment.
+
+## Reporting Bugs
+
+Use the GitHub issue tracker at <github url> to report bugs. When filing an issue, please include:
+
+- A clear title and description.
+- As much relevant information as possible.
+- A code sample or an executable test case demonstrating the expected behavior that is not occurring.
+
+## Feature Requests
+
+Feature requests are welcome. Please provide a clear description of the feature and why it would be beneficial to the project. You can submit feature requests through the GitHub issue tracker.
+
+## Questions?
+
+If you have any questions, feel free to open an issue or reach out to the maintainers through the GitHub repository.
+
+Thank you for contributing to Specif AI!

LICENSE

@@ -0,0 +1,26 @@
+MIT License
+
+Copyright (c) Presidio, Inc. and affiliates.
+
+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.
+
+The Software may include logos, trademarks, and other branding assets 
+(“Branding”) of Presidio, Inc. Use of the Branding in modified or redistributed 
+versions of the Software requires removal or replacement unless prior written 
+permission is obtained from Presidio, Inc.

README.md

@@ -0,0 +1,221 @@
+<div align="center">
+  <img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License" />
+  <img src="https://img.shields.io/github/issues/presidio-oss/specif-ai" alt="Issues" />
+  <img src="https://img.shields.io/github/stars/presidio-oss/specif-ai" alt="Stars" />
+  <img src="https://img.shields.io/github/forks/presidio-oss/specif-ai" alt="Forks" />
+</div>
+<br />
+<div align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="assets/img/hai-build-logo-light.png">
+    <source media="(prefers-color-scheme: light)" srcset="assets/img/hai-build-logo-theme.png">
+    <img alt="HAI Logo" src="assets/img/hai-build-logo-white-bg.png" height="auto">
+  </picture>
+</div>
+<br />  
+<div align="center">
+  <em>Accelerate your SDLC process with AI-powered intelligence.<br>
+  From ideas to actionable tasks in minutes.</em>
+</div>
+<br>
+
+# 🚀 Specif AI
+
+**Specif AI** is an AI-powered platform that transforms the project requirements management. It combines AI technology with intuitive workflows to automate documentation, generate and manage tasks - all while adapting to your team's specific needs.
+<div align="center">
+    <img src="assets/gifs/specif-ai-overview.gif" alt="Specif AI in Action" width="900">
+</div>
+
+## Table of Contents
+- [🌟 Overview](#overview)
+- [📥 Getting Started](#getting-started)
+- [✨ Key Features](#key-features)
+   - [🔌 Integrations](#integrations)
+- [🏗 Architecture](#architecture)
+- [📝 Version-Controlled Requirements Management](#version-controlled-requirements-management)
+- [🗺 Roadmap](#roadmap)
+- [🤝 Contributing](#contributing)
+- [📜 License](#license)
+- [📧 Contact](#-contact)
+
+## 🌟 Overview
+
+In today's fast-paced software development landscape, delivering high-quality solutions quickly is more critical than ever. Specif AI is a cutting-edge platform that revolutionizes how teams generate, manage, and refine software requirements by combining AI intelligence with human context.
+
+By simply providing a solution name, description, and tech stack details, Specif AI automatically generates comprehensive documentation, including:
+
+- 📄 Business Requirement Documents (BRD)
+- 🔧 Non-Functional Requirements Documents (NFRD)
+- 📱 Product Requirement Documents (PRD)
+- 🎨 User Interface Requirements (UIR)
+- 🔄 Business Process Flows
+
+<div align="center">
+    <img src="assets/gifs/specif-ai-sections.gif" alt="Document Generation Demo" width="900">
+</div>
+
+## 📥 Getting Started
+
+### Setup Instructions
+
+1. **Clone the repository**
+   ```bash
+   git clone https://github.com/presidio-oss/specif-ai.git
+   cd specif-ai
+   ```
+
+2. **Set up the Backend**
+
+   Prerequisites: Python >= 3.11
+
+   ```bash 
+   # Navigate to backend directory
+   cd backend
+
+   # In env.sh file, Add your OpenAI API key to the OPENAI_API_KEY variable. 
+   # Configure additional settings as needed in env.sh
+   # Then, Activate the environment variables by running:
+   source env.sh
+
+   # Build the image
+   docker build . --tag hai-build-requirement-backend
+
+   # Run the container
+   docker run -p 5001:5001 \
+   -e APP_PASSCODE_KEY=$APP_PASSCODE_KEY \
+   -e OPENAI_API_KEY=$OPENAI_API_KEY \
+   -e OPENAI_API_BASE=$OPENAI_API_BASE \
+   -e AZUREAI_API_BASE=$AZUREAI_API_BASE \
+   -e AZUREAI_API_KEY=$AZUREAI_API_KEY \
+   -e AZUREAI_API_VERSION=$AZUREAI_API_VERSION \
+   -e CLAUDE_API_KEY=$CLAUDE_API_KEY \
+   -e CLAUDE_ENDPOINT=$CLAUDE_ENDPOINT \
+   -e HOST=$HOST \
+   -e PORT=$PORT \
+   -e DEBUG=$DEBUG \
+   -e ENABLE_SENTRY=$ENABLE_SENTRY \
+   -e SENTRY_DSN=$SENTRY_DSN \
+   -e SENTRY_ENVIRONMENT=$SENTRY_ENVIRONMENT \
+   -e SENTRY_RELEASE=$SENTRY_RELEASE \
+   -it hai-build-requirement-backend
+   ```
+
+3. **Download the Specif AI desktop application** from the [releases page](https://github.com/presidio-oss/specif-ai/releases).
+4. **Run** the Desktop Application
+
+For detailed setup instructions, refer to:
+- [Backend Server Configuration Setup](./backend/README.md)
+- [Electron Desktop Application Setup](./electron/README.md)
+   - [Angular UI Setup](./ui/README.md)
+
+### 💻 App Setup
+
+<img src="assets/img/specif-ai-welcome-page.png" alt="Welcome Page" width="900" />
+
+1. **APP URL:** The app's backend base URL (For local development: `http://127.0.0.1:5001/`).
+
+2. **APP PASSCODE:** Use the same passcode provided during the [Backend](./backend/README.md) setup (For local development: `7654321`).
+
+For more details, refer to the [Backend Server Setup Configuration Settings](./backend/README.md).
+
+## ✨ Key Features
+
+- **🤖 AI-Powered Document Generation**: Effortlessly create detailed SDLC documentation.
+- **💬 Intelligent Chat Interface**: Get real-time requirement edits and context-specific suggestions.
+
+<div align="center">
+
+![AI powered chat feature in action](assets/gifs/specif-ai-chat.gif)  
+*AI powered chat feature in action*
+
+</div>
+
+- **📊 Business Process Visualization**: Easily generate and manage process flows.
+- **📋 User Story Generation**: Convert requirements into actionable user stories and tasks.
+
+<div align="center">
+
+![User story and task generation](assets/gifs/specif-ai-user-stories.gif)  
+*User story and task generation*
+</div>
+
+- **🔄 Real-time Collaboration**: Collaborate and refine requirements with team members.
+- **📱 Desktop Integration**: Seamlessly integrate with your existing workflow tools.
+
+- **🔄 Multi-Modal Support**: Choose the model that best suits your needs. Supported models include:
+   - Azure OpenAI
+      - gpt-4o
+      - gpt-4o-mini
+   - OpenAI Native
+      - gpt-4o
+      - gpt-4o-mini
+   - AWS Bedrock
+      - anthropic.claude-3-5-sonnet-20240620-v1:0
+
+<div align="center">
+
+![Model Switch](assets/gifs/specif-ai-settings.gif)  
+*Switch between models seamlessly*
+
+</div>
+
+
+
+
+### 🔌 Integrations
+
+Specif AI seamlessly integrates with popular tools to enhance your workflow:
+
+#### Jira Integration
+The stories and tasks generated as part of the solutions can be used to create actual stories and tasks in your Jira instance using the Jira integration provided by the application. Features include:
+- Automatic story and task creation in Jira.
+- Bulk export capabilities.
+
+For Jira setup instructions, please refer to our [Jira Setup Guide](/ui/JIRA-README.md).
+
+#### AWS Bedrock Knowledge Base
+> **Note**: The AWS Bedrock Knowledge Base features are configurable when the backend server is deployed in AWS. Local deployments will not have access to these enhanced capabilities.
+
+The enterprise knowledge base is integrated with AI-powered chat to enhance suggestions and enable iterative conversations for Business Requirement Documents (BRDs), Product Requirement Documents (PRDs), Non-functional Requirements, User Stories, and Tasks. Features include: 
+
+- Enhanced chat suggestions through enterprise knowledge.
+- Context-aware requirement generation.
+- Historical data integration.
+
+## 🏗 Architecture
+
+Specif AI follows a modern, scalable architecture designed for optimal performance and maintainability.
+
+<div align="center">
+    <img src="assets/img/specif-ai-architecture.png" alt="Application Architecture Diagram"/>
+</div>
+
+## 📝 Version Controlled Requirements Management Made Easy
+
+Specif AI is a powerful desktop application built to streamline and organize your project requirements. With Specif AI, users can create a unified directory where all essential files are not only accessible and editable but also seamlessly synced with platforms like OneDrive, Dropbox, or any git-enabled local folder. This setup allows users to point to specific artifacts and data sources in a version-controlled environment, making collaboration and tracking effortless. Our goal is to enhance your development workflow by integrating seamlessly with the tools you already use, without adding complexity or obstacles.
+
+
+## 🗺 Roadmap
+
+- [ ] Advanced BRD-PRD linking capabilities.
+- [ ] Enhanced collaboration features.
+- [ ] Custom template support.
+- [ ] v2.0 - Web version with enhanced collaboration capabilities.
+
+## 🤝 Contributing
+
+To contribute to the project, start by exploring [open issues](https://github.com/presidio-oss/specif-ai/issues) or checking our [feature request board](https://github.com/presidio-oss/specif-ai/discussions/categories/feature-requests?discussions_q=is%3Aopen+category%3A%22Feature+Requests%22+sort%3Atop).
+
+Please read our [Contributing Guidelines](./CONTRIBUTING.md) for more details.
+
+## 📜 License
+
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+Thanks to all contributors and users for their support and feedback.
+
+## 📧 Contact
+
+For any questions or feedback, please contact us at [hai-feedback@presidio.com](mailto:hai-feedback@presidio.com).

backend/.gitignore

@@ -0,0 +1,52 @@
+# These are some examples of commonly ignored file patterns.
+# You should customize this list as applicable to your project.
+# Learn more about .gitignore:
+#     https://www.atlassian.com/git/tutorials/saving-changes/gitignore
+
+# Node artifact files
+node_modules/
+dist/
+env/
+.venv/
+
+# Compiled Java class files
+*.class
+
+# Compiled Python bytecode
+*.py[cod]
+
+# Log files
+*.log
+
+# Package files
+*.jar
+
+# Maven
+target/
+dist/
+
+# JetBrains IDE
+.idea/
+
+# Unit test reports
+TEST*.xml
+
+# Generated by MacOS
+.DS_Store
+
+# Generated by Windows
+Thumbs.db
+
+# Applications
+*.app
+*.exe
+*.war
+
+# Large media files
+*.mp4
+*.tiff
+*.avi
+*.flv
+*.mov
+*.wmv
+

backend/Dockerfile

@@ -0,0 +1,20 @@
+# Use the official Python 3.12 image as the base
+FROM python:3.12
+
+# Set the working directory inside the container
+WORKDIR /usr/src/app
+
+# Copy the requirements.txt file to the container
+COPY requirements.txt .
+
+# Install the Python dependencies
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Copy the rest of the application code to the container
+COPY . .
+
+# Expose port 5001 to the host machine
+EXPOSE 5001
+
+# Set the default command to run the application
+CMD ["python", "init.py"]