How sayamkhatri/ai-powered-prompt-engineering-assistant works
Main components
• Backend: A Python application (located in the backend directory) that contains various modules such as main.py, detect_pii.py, prompt_classifier.py, prompt_score.py, and several prompt template-related files. This component likely handles processing of prompts including AI-based prompt engineering, PII detection, scoring, and template management.
• Infrastructure/Deployment: The presence of a Dockerfile and GitHub workflow configuration (under .github/workflows/deploy.yml) indicate that the project includes containerization and automated deployment setups.
File structure for architectural clues
• The separation into a backend folder and a chrome-extension folder suggests a clear separation of concerns where the backend does the heavy lifting of processing and AI functionalities while the Chrome extension offers an interactive frontend.
• Look at the Python modules: each script in the backend might represent a specific functionality (e.g., detect_pii.py for detecting sensitive data, prompt_score.py for scoring prompts), suggesting a modular or service-oriented architecture within the backend.
• GitHub workflows and requirements.txt indicate the project’s build and dependency management are clearly laid out.