Thanks to visit codestin.com
Credit goes to github.com

Skip to content

vsuyi/ai-shifu

 
 

Repository files navigation

Everything you see is tailored just for you

English | 简体中文

AI-Shifu serves as a teacher, broadcaster, storyteller, and guide... As an AI-driven narrator, AI-Shifu can present any textual content to each user in a fully personalized way, creating an unprecedented reading experience.

Architecture

Features

  1. Personalized Output: Fully personalized content output based on user's identity, background, interests and preferences, comparable to one-on-one human interaction.
  2. Rich Media: Supports multiple content formats including Markdown, HTML, Mermaid diagrams, as well as embedded images and videos.
  3. Content Safety: Master scripts control all output to reduce hallucinations and ensure content quality.
  4. Q & A: Users can ask questions at any time to get contextually relevant intelligent answers.
  5. Interactive: Ask questions to users at any time, driving subsequent processes based on user responses.
  6. Script Editor: Easily edit scripts and preview effects.

Roadmap

  • Overall refactoring
  • Writing AI agent for rapid script generation and maintenance
  • Knowledge base
  • Speech input and output

Using AI-Shifu

Platform

AI-Shifu.com is an education platform powered by AI-Shifu. You can try it and learn the AI-guided courses developed by human experts.

Self-hosting

For source code installation, please refer to the Installation Manual

Make sure your machine has installed Docker and Docker Compose.

Using Docker Hub image

git clone https://github.com/ai-shifu/ai-shifu.git
cd ai-shifu/docker

# For minimal setup (only required variables):
cp .env.example.minimal .env

# Or for full configuration options:
cp .env.example.full .env

# Edit .env and configure the required variables:
# - SQLALCHEMY_DATABASE_URI: Database connection
# - SECRET_KEY: JWT signing key (generate with: python -c "import secrets; print(secrets.token_urlsafe(32))")
# - UNIVERSAL_VERIFICATION_CODE: Test verification code
# - At least one LLM API key (OPENAI_API_KEY, ERNIE_API_KEY, etc.)

docker compose up -d

Building from source code

git clone https://github.com/ai-shifu/ai-shifu.git
cd ai-shifu/docker

# Choose configuration template:
cp .env.example.minimal .env  # For minimal setup
# OR
cp .env.example.full .env      # For full configuration

# Configure the required variables in .env file
# See .env.example.minimal for required variables
# See .env.example.full for all available options

./dev_in_docker.sh

Access

After Docker starts:

  1. Open http://localhost:8080 in your browser to access the user interface
  2. Open http://localhost:8081 in your browser to access the script editor
  3. Use any phone number for login; the default universal verification code is 1024 (for demo/testing only — change or disable in production)

About

LLM-powered AI guide that leads and drives intelligent conversations

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 48.0%
  • TypeScript 42.8%
  • SCSS 5.1%
  • MDX 2.0%
  • CSS 0.9%
  • JavaScript 0.8%
  • Other 0.4%