build-advisor / README.md
cmagganas's picture
Update README.md
047ca1c verified
metadata
title: Build Advisor
emoji: 🚀
colorFrom: blue
colorTo: pink
sdk: docker
pinned: false
license: mit

Welcome to Build Advisor! 🛠️✨

Build Advisor is an AI app designed to help guide AI developers in building their AI applications. With Build Advisor, you can:

  • Create a plan: Get a structured plan for your AI project.
  • Generate product requirement specifications: Define the necessary specifications to build your app.
  • Implement solutions: Quickly create a Proof of Concept (PoC) to evaluate your ideas.

Why Use Build Advisor?

  • Determine project worth: Assess whether your idea is worth starting, investing time, and investing money.
  • Leverage AI expertise: Utilize LLMs and effective prompt engineering for optimal results.

Getting Started

  1. Install dependencies:

    pip install -r requirements.txt
    
  2. Run the application:

    chainlit run app.py -w
    

Features and Roadmap

Current Version (v1)

  • Deploy on HF spaces: Make your project accessible on Hugging Face spaces.
  • Landing Page Intro: Include an introduction: "I am... I do... how to use me..."

Week 2 (W2)

  • Work with SME: Get a few-shot examples (3+) for each agent:
    • Definition agent
    • Specification agent
  • PDF Output: Create and manage PDF outputs:
    • Open PDF view
    • Download PDF
    • Feedback box for user input (good/bad, suggestions for changes)
  • Iteration: Work section-by-section with saved states for feedback-based modifications.

Business Value: 🚦Green Light Projects

  • v1

    • Definition (What?): Product Requirement Definition
    • Specification (How?): Engineering/Function
  • v2

    • Plan (When? Who?): Resource Allocator

We hope Build Advisor helps streamline your AI development process! Happy building! 🚀😊