Skip to content

README.md

Latest commit

 

History

History
136 lines (99 loc) · 3.34 KB

README.md

File metadata and controls

136 lines (99 loc) · 3.34 KB
Raw

🚗 Gen AI Vehicle Assistant

Welcome to the Gen AI Vehicle Assistant repository!
This project leverages Azure OpenAI and Azure Search to power an intelligent assistant that helps users instantly find the right vehicle—right when they walk into the dealership

📎 Quick Links

🧱 Tech Stack

🖥 Frontend

  • React: Core UI framework
  • Vite: Fast development & build tool
  • Tailwind CSS + DaisyUI: Utility-first and component styling
  • Yarn: Dependency management

🔧 Backend

  • C# / .NET: API server
  • Azure SQL Database: Vehicle data storage
  • Azure App Service: App hosting + Artifact Deploys
  • Azure OpenAI & Azure Search: Natural language processing + database keyword search

⚙️ Getting Started

🛠 Prerequisites

  • Node.js: Download
  • .NET 8 SDK
  • Yarn: npm install --global yarn

🔧 Setup

# Install dependencies
cd front-end && yarn install

# Create Vite project (if setting up manually)
yarn create vite --template react-swc

# Add Tailwind CSS
# Refer: https://tailwindcss.com/docs/installation/using-vite

# Add DaisyUI
# Refer: https://daisyui.com/docs/install/

# Optional: Prettier for code formatting
yarn add -D prettier prettier-plugin-tailwindcss

Add to package.json:

"scripts": {
  "format": "prettier --write ."
}

🧪 Running the Project

🔄 Common Commands (from project root)

  • Init/refresh project: yarn fresh
  • Dev server (frontend + backend): yarn dev
  • Start project: yarn start
  • Build project: yarn build

▶️ Run Individually

  • Frontend only: 
    cd front-end
yarn dev
  • Backend only: 
    cd back-end
dotnet run

✅ Testing

Frontend (Cypress)

Location: front-end/cypress/e2e

Run Tests:

cd front-end
yarn install

# Start dev server
yarn dev

# New terminal:
yarn cypress:run --spec "cypress/e2e/vehicle-search.cy.js"

Tests Cover:

  • Feature filters
  • Page navigation
  • UI behavior

Backend (xUnit)

Location: back-end/Testing

Run Tests:

cd back-end

# Add required packages
 dotnet add package Microsoft.NET.Test.Sdk
 dotnet add package xunit
 dotnet add package xunit.runner.visualstudio
 dotnet add package coverlet.collector

# Run tests
 dotnet test

👥 Team Members