NithiishSD/ai_avatar_plateform

0

stars

22

commits

Python

primary language

Sep 4, 2026

updated

README

AI Avatar Platform

This project contains a FastAPI backend and a React + Vite frontend for the avatar generation workflow.

Prerequisites

  • Python 3.10 (recommended for Coqui TTS / XTTS-v2 & lip-sync pipelines)
  • Node.js 18+ and npm
  • Docker and Docker Compose
  • Git

Quick start

1) Create the environment file

From the project root:

cp .env.example .env

2) Create and activate the Conda environment inside backend

Navigate to the backend directory:

cd backend
conda create --prefix ./.conda python=3.10 -y
conda activate ./.conda

3) Install Python dependencies

From inside the backend/ directory:

pip install -r requirements.txt
pip install --no-deps TTS==0.22.0

4) Start infrastructure containers with Docker

This project uses Redis and PostgreSQL for local infrastructure.

./start-docker.sh

You can stop the containers with:

docker compose -f backend/docker-compose.yml down

5) Start the backend API

From the project root:

cd backend
PYTHONPATH=. python -m uvicorn app:app --host 0.0.0.0 --port 8000 --reload

The API will be available at:

6) Start the frontend

Open a second terminal and run:

cd frontend
npm install
npm run dev -- --host 0.0.0.0 --port 5173

The frontend will be available at:

Project structure

.
├── backend/
│   ├── .conda/           # Conda environment (Python 3.10)
│   ├── app.py
│   ├── celery_app.py
│   ├── contracts.py
│   ├── docker-compose.yml
│   ├── job_queue.py
│   ├── requirements.txt
│   ├── voice_engine.py
│   └── outputs/
├── frontend/
│   ├── src/
│   ├── package.json
│   └── vite.config.js
├── docs/
├── tests/
├── .env.example
├── README.md
├── start-docker.sh
├── inputs/
└── outputs/

Useful commands

Run backend tests

cd /home/nithiish/Documents/ai_avatar_plateform
PYTHONPATH=backend ./backend/.conda/bin/python -m unittest discover -s tests -p 'test_*.py' -q

Build frontend for production

cd frontend
npm run build

Notes

  • The default queue backend is set to in_memory in .env.example for local development.
  • If you want to use Celery/Redis queue processing, set QUEUE_BACKEND=celery in your environment and make sure Redis is running.
  • The frontend is configured to call the backend from http://localhost:8000 with CORS enabled for local development.
  • Hardware Fallback: The platform automatically detects whether an NVIDIA GPU with CUDA is available. If no GPU is present, all models and rendering pipelines seamlessly fall back to CPU execution without manual configuration.

Contributors

NithiishSD

21 commits

VishwajithGS

1 commits

NithiishSD/ai_avatar_plateform

0

stars

22

commits

Python

primary language

Sep 4, 2026

updated

README

AI Avatar Platform

This project contains a FastAPI backend and a React + Vite frontend for the avatar generation workflow.

Prerequisites

  • Python 3.10 (recommended for Coqui TTS / XTTS-v2 & lip-sync pipelines)
  • Node.js 18+ and npm
  • Docker and Docker Compose
  • Git

Quick start

1) Create the environment file

From the project root:

cp .env.example .env

2) Create and activate the Conda environment inside backend

Navigate to the backend directory:

cd backend
conda create --prefix ./.conda python=3.10 -y
conda activate ./.conda

3) Install Python dependencies

From inside the backend/ directory:

pip install -r requirements.txt
pip install --no-deps TTS==0.22.0

4) Start infrastructure containers with Docker

This project uses Redis and PostgreSQL for local infrastructure.

./start-docker.sh

You can stop the containers with:

docker compose -f backend/docker-compose.yml down

5) Start the backend API

From the project root:

cd backend
PYTHONPATH=. python -m uvicorn app:app --host 0.0.0.0 --port 8000 --reload

The API will be available at:

6) Start the frontend

Open a second terminal and run:

cd frontend
npm install
npm run dev -- --host 0.0.0.0 --port 5173

The frontend will be available at:

Project structure

.
├── backend/
│   ├── .conda/           # Conda environment (Python 3.10)
│   ├── app.py
│   ├── celery_app.py
│   ├── contracts.py
│   ├── docker-compose.yml
│   ├── job_queue.py
│   ├── requirements.txt
│   ├── voice_engine.py
│   └── outputs/
├── frontend/
│   ├── src/
│   ├── package.json
│   └── vite.config.js
├── docs/
├── tests/
├── .env.example
├── README.md
├── start-docker.sh
├── inputs/
└── outputs/

Useful commands

Run backend tests

cd /home/nithiish/Documents/ai_avatar_plateform
PYTHONPATH=backend ./backend/.conda/bin/python -m unittest discover -s tests -p 'test_*.py' -q

Build frontend for production

cd frontend
npm run build

Notes

  • The default queue backend is set to in_memory in .env.example for local development.
  • If you want to use Celery/Redis queue processing, set QUEUE_BACKEND=celery in your environment and make sure Redis is running.
  • The frontend is configured to call the backend from http://localhost:8000 with CORS enabled for local development.
  • Hardware Fallback: The platform automatically detects whether an NVIDIA GPU with CUDA is available. If no GPU is present, all models and rendering pipelines seamlessly fall back to CPU execution without manual configuration.

Contributors

NithiishSD

21 commits

VishwajithGS

1 commits

Languages

Python

69.2%

JavaScript

26.4%

CSS

3.7%