README.md

SmartTutorial

SmartTutorial : a web app to make interactive, ‘intelligent’ tutorials based on your codebase and domain-specific knowledge.

Write a minimal tutorial with general key points, add links to your codebase repo, and let SmartTutorial generate for you a complete and detailed tutorial based on your programming domain.

Backend : Python

• Install the required packages from Pipfile

make install-backend or pipenv install

• Add your OpenAI key in an .openai-key file in the root folder

• Install embeddings for Compas

make install-data

• Run the server

make run-backend or pipenv run backend

• Serve as daemon

make start-backend

make stop-backend

Frontend : Vue

• Install and run the vue app

make build-frontend or cd frontend && npm install

Sample

References

• Annoy (Approximate Nearest Neighbors Oh Yeah)
• LlamaIndex Github Repo Reader
• LlamaIndex Vector Store Index
• private-gpt
• script-gpt
• gpt-researcher