ASSISTENTE 0.1.1

🤖 ASSISTENTE.DEV - Your Coding Companion

Website | Nuget

Struggling to keep track of all your dev notes, bookmarks, and useful code snippets scattered across different platforms? Frustrated by the time wasted searching for that crucial information or starting from scratch? 🤔

Introducing assistente.dev – your ultimate assistant for developers. It's your personal memory bank, effortlessly storing and retrieving everything you need, precisely when you need it. Whether it's code snippets, course notes, or example solutions, Assistende has you covered. 🦾

Simply paste your query and watch as assistente.dev draws from your notes, bookmarks, and code bases to provide the perfect solution. With assistente.dev, say goodbye to wasted time and hello to seamless development. Get started and unlock your productivity potential! 🚀

Roadmap

Phases:

• ✅ I phase (POC) - console app for test purpose Playground: QUICK LINK
• 🔳 II phase - UI in Blazor + publish application on VPS
• 🔳 III phase - Improving prompts and logic to generate the most accurate answers

Loading user data

TODO:

• ✅ Loading and parsing *.md files - knowledge base
• ✅ Loading and parsing *.cs files - code base
• ✅ Find open source solution for creating embeddins
  • ✅ Done partially (currently in use OpenAI embedding service)
  • 🔳 NICE TO HAVE Integrate LLamaSharp for embeding creation
• ✅ Integration with Qdrant - saving embeddings

Generating results

• ✅ Generating prompt based on the 'knowledge base' & 'code base'
  • ✅ Generate prompt based on 'knowledge base'
  • ✅ Generate prompt based on 'code base'
• ✅ Integration with the OpenAI API
• ✅ Add usage of MediatR and prepare Command & Queries libraries
• ✅ Generating answers or ready code (in console app) - depending on what the user needs
• ✅ Add UI in Blazor
  • ✅ Upload sample notes and code from DEV_ASSISTENTE repository for demo purpose
  • ✅ Generating answers asynchronously (RabbitMQ + SignalR)
  • ✅ Display resources list
  • ✅ Display asked questions with answers list
• 🔳 Configure VPS to host all environment

Nice to have

• 🔳 Add library for translation (prompts and knowledge base)

Common tasks

• ✅ Prepare configuration section in Readme
• ✅ Prepare quick start section in Readme
• 🔳 Prepare video explainer with simply demo

Quick start

Prerequisites: .NET 8 + Docker

1. Run services on your local machine:

   • REQUIRED Messages broker: RabbitMq - EXAMPLE CONFIGURATION
   • REQUIRED Vector database: Qdrant - EXAMPLE CONFIGURATION
   • OPTIONAL Logs and traces: Seq - EXAMPLE CONFIGURATION

2. Setup MSSQL database - can be hosted in docker - EXAMPLE CONFIGURATION

3. Fill out the settings file (appsettings.json) from CONFIGURATION section

4. Run upgrade-database.ps1 script to create/migrate database - QUICK LINK

5. Run learn.ps1 script to initialize and learn notes & codes from locations provided in appsettings.json (node: KnowledgePaths).

6. Voila! Currently you can start application:

• From Rider/Visual Studio, required applications to run:
  • ASSISTENTE.Worker.Sync
  • ASSISTENTE.API
  • ASSISTENTE.UI
• In docker - run start-local-enviroment.ps1 script

Configuration

1. Fill out the settings file appsettings.json - QUICK LINK

{
  "ConnectionStrings": {
    "AssistenteDatabase": "<DATABASE_CONNECTION_STRING>"
  },
  "OpenAI": {
    "ApiKey": "<API_KEY>"
  },
  "Qdrant": {
    "Host": "localhost"
  },
  "Rabbit": {
    "Name": "ASSISTENTE.Worker.Sync",
    "Url": "amqp://guest:guest@localhost:5672"
  },
  "InternalApi": {
    "Url": "http://localhost:5249"
  },
  "KnowledgePaths": {
    "MarkdownNotes": "<ROOT_PATH_TO_MARKDOWN_NOTES>",
    "Repositories": "<ROOT_PATH_TO_REPOSITORY>"
  },
  "Serilog": {
    "MinimumLevel": {
      "Default": "Information",
      "Override": {
        "Microsoft": "Warning",
        "System": "Warning"
      }
    },
    "Enrich": [ "FromLogContext", "WithMachineName", "WithProcessId", "WithThreadId" ],
    "WriteTo": [
      { "Name": "Console" },
      {
        "Name": "Seq",
        "Args": {
          "serverUrl": "http://localhost:5341"
        }
      }
    ]
  }
}

2. Fill out the .env file - QUICK LINK

COMPOSE_PROJECT_NAME=assistente

ConnectionStrings_AssistenteDatabase='<DATABASE_CONNECTION_STRING>'
OpenAI_ApiKey='<API_KEY>'
Qdrant_Host='localhost'
Rabbit_Name='ASSISTENTE.Worker.Sync'
Rabbit_Url='amqp://guest:guest@rabbitmq:5672'
InternalApi_Url='http://assistente-api:8080'
KnowledgePaths_MarkdownNotes=<ROOT_PATH_TO_MARKDOWN_NOTES>
KnowledgePaths_Repositories=<ROOT_PATH_TO_REPOSITORY>