Customised README and project name
This commit is contained in:
parent
559912c448
commit
ba97dfdab3
3 changed files with 77 additions and 6 deletions
75
README.md
75
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.
|
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)
|
||||||
|
|
|
||||||
4
package-lock.json
generated
4
package-lock.json
generated
|
|
@ -1,11 +1,11 @@
|
||||||
{
|
{
|
||||||
"name": "@api/source",
|
"name": "dynavera",
|
||||||
"version": "0.0.0",
|
"version": "0.0.0",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "@api/source",
|
"name": "dynavera",
|
||||||
"version": "0.0.0",
|
"version": "0.0.0",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "@api/source",
|
"name": "dynavera",
|
||||||
"version": "0.0.0",
|
"version": "1.0.0",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"start:api": "nx serve apps/api",
|
"start:api": "nx serve apps/api",
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue