From ba97dfdab31dc40e376ceb0a73a6179070f5e3ab Mon Sep 17 00:00:00 2001 From: Viswamedha Nalabotu Date: Mon, 10 Nov 2025 18:36:31 +0000 Subject: [PATCH] Customised README and project name --- README.md | 75 +++++++++++++++++++++++++++++++++++++++++++++-- package-lock.json | 4 +-- package.json | 4 +-- 3 files changed, 77 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 003f28f..03007d1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,75 @@ +# An Agentic Approach to Domain-Specific Trainers -# An agentic approach to domain specific trainers +A proof-of-concept platform for **automating the induction and support of new hires or team members** into a role or domain using **AI agents**. This project demonstrates a reusable workflow that combines a modern full-stack application with AI-driven guidance and assessment. -The key things to "prove" are to create a reusable workflow with AI agents, capable of automating the induction and support of a new hire/new team member into a role/field and also to test the suitability of this tool within a real world scenario. \ No newline at end of file +Tentative app name: Dynavera + +--- + +## Table of Contents + +* [Project Goals](#project-goals) +* [Tech Stack](#tech-stack) +* [Architecture](#architecture) +* [Features](#features) +* [Setup](#setup) +* [Usage](#usage) +* [Future Work](#future-work) +* [License](#license) + +--- + +## Project Goals + +The main objectives of this project are: + +1. **Reusable Workflow** – Create a pipeline that can automatically onboard and guide new hires or team members in a specific domain. +2. **AI Agent Integration** – Use intelligent agents to provide guidance, monitor progress, and adapt learning to individual users. +3. **Real-World Testing** – Evaluate the suitability and effectiveness of the tool in realistic onboarding scenarios. +4. **Domain Specific Trainers** – Support the creation of trainers specialized for different roles, fields, or industries. + +--- + +## Tech Stack + +* **Backend:** [NestJS](https://nestjs.com/) +* **Frontend:** [Vue 3](https://vuejs.org/) + [Vite](https://vitejs.dev/) +* **AI Agents:** Python or JavaScript (TBD) +* **Database:** (TBD) +* **Authentication:** JWT / OAuth2 / Custom Managed + +--- + +## Features + +* Automated onboarding workflow for new hires. +* Role/domain-specific AI training modules. +* Adaptive guidance and personalized learning paths. +* Dashboard for tracking user progress and feedback. +* Modular AI agent integration (Python/JS). +* Extensible to multiple domains and roles. + +--- + +## Setup + +TBC + +--- + +## Usage + +1. Navigate to the frontend URL (hosted at `https://project.viswamedha.com`). +2. Register a new user or login. +3. Select the role/domain to train in. +4. Follow the guided AI-assisted onboarding workflow. +5. Track progress and view recommendations on the dashboard. + +--- + + +--- + +## License + +[MIT License](LICENSE) diff --git a/package-lock.json b/package-lock.json index cc1da64..8accf1e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "@api/source", + "name": "dynavera", "version": "0.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "@api/source", + "name": "dynavera", "version": "0.0.0", "license": "MIT", "dependencies": { diff --git a/package.json b/package.json index 346b1cb..730e32e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { - "name": "@api/source", - "version": "0.0.0", + "name": "dynavera", + "version": "1.0.0", "license": "MIT", "scripts": { "start:api": "nx serve apps/api",