From b8d58b312670b76ad1ffda9489a989f8b90b49a5 Mon Sep 17 00:00:00 2001
From: Viswamedha Nalabotu <vxn217@student.bham.ac.uk>
Date: Sat, 17 Jan 2026 20:32:58 +0000
Subject: [PATCH] Added readme file

---
 README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b18a24a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+# An Agentic Approach to Role-Specific Trainers - Dynavera
+
+A proof-of-concept platform for **automating the induction and support of new hires or team members** into a role using **AI agents**. This project demonstrates a reusable workflow that combines a modern full-stack application with AI-driven guidance and assessment.
+
+---
+
+## Table of Contents
+
+-   [Project Goals](#project-goals)
+-   [Tech Stack](#tech-stack)
+-   [Features](#features)
+-   [Usage](#usage)
+
+---
+
+## 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 role.
+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. **Role Specific Trainers** – Support the creation of trainers specialized for different roles, fields, or industries.
+
+---
+
+## Tech Stack
+
+-   **Backend:** [Django](https://www.djangoproject.com/)
+-   **Frontend:** [Vue 3](https://vuejs.org/) + [Vite](https://vitejs.dev/)
+-   **AI Agents:** Python-based agents using websockets and potentially LangChain
+-   **APIs:** RESTful APIs using [Django REST Framework](https://www.django-rest-framework.org/)
+-   **Containerization:** [Docker](https://www.docker.com/) + [Docker Compose](https://docs.docker.com/compose/)
+-   **Database:** [PostgreSQL](https://www.postgresql.org/)
+-   **Websockets:** [Django Channels](https://channels.readthedocs.io/en/stable/)
+-   **State Management:** [Pinia](https://pinia.vuejs.org/)
+-   **Authentication:** JWT / OAuth2 / Django
+
+---
+
+## Features
+
+-   Automated onboarding workflow for new hires.
+-   Role-specific AI training modules.
+-   Adaptive guidance and personalized learning paths.
+-   Dashboard for tracking user progress and feedback.
+-   Modular AI agent integration (Python/JS).
+
+---
+
+## Usage
+
+1. Navigate to the frontend URL (hosted at `https://project.viswamedha.com`).
+2. Register a new user or login.
+3. Select the role to train in.
+4. Follow the guided AI-assisted onboarding workflow.
+5. Track progress and view recommendations on the dashboard.