"ReadMe" is an AI-powered system designed to transform boring, static text inputs (such as brochures or PDFs) into engaging and interactive video content. In addition to video generation, it creates quizzes to test users' understanding of the content and provides detailed analytics on user engagement. By reading out text in an entertaining way, ReadMe makes information more digestible and enjoyable to interact with.
Linux or Windows with WSL
wget http://archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2_amd64.deb
sudo dpkg -i libssl1.1_1.1.1f-1ubuntu2_amd64.deb
install backend and frontend dependencies from the requirements.txt and package.json
To start the frontend:
- Navigate to
/frontend - Run the development server:
npm run dev
To start the backend
- Navigate to
/backend - Start redis via docker
docker run -d -p 6379:6379 redis - Start Celery worker for background tasks:
watchmedo auto-restart -d .. -p '*.py' --recursive -- celery -A readme.celery worker - Start the Django server:
python manage.py runserver
Fig: Home Page
Fig: Edit Script Page
Fig: Video Preview Page
Fig: Quiz Page
For any information required, do not hesitate to contact miranfirdausi027@gmail.com or saumay123sj@gmail.com
- Thanks to Celery for handling asynchronous tasks.