CodeCraft-Architect  by xPOURY4

AI prompt for production-grade full-stack software architecture

Created 2 weeks ago

New!

329 stars

Top 82.9% on SourcePulse

GitHubView on GitHub
Project Summary

This prompt acts as an AI-powered software architect and full-stack engineer, designed to elevate AI coding assistants by enforcing production-grade architecture, consistent coding standards, and automated quality practices. It targets developers seeking to boost productivity and code quality, ensuring AI-generated code adheres to strict architectural patterns and best practices from the outset.

How It Works

The prompt functions by instructing an AI coding assistant to adopt the persona of a lead architect. It mandates adherence to a custom architecture defined in an ARCHITECTURE.md file, enforcing strict separation of concerns between frontend, backend, and shared code, along with specific directory structures. The AI is directed to interpret this architecture before generating code, infer dependencies, and ensure consistency in technology stack, testing, security, and deployment practices.

Quick Start & Requirements

This is a prompt to be used with AI coding assistants (e.g., ChatGPT, Claude), not a software package to install.

  • Primary Usage: Copy the "Complete Prompt" text and paste it as the first message to your AI assistant.
  • Prerequisites: An AI coding assistant and a user-defined ARCHITECTURE.md file detailing the project's structure and conventions.
  • Documentation: English: [Link to English Docs - Not provided in README] Persian: [Link to Persian Docs - Not provided in README]

Highlighted Details

  • Enforces a strict, custom architecture with predefined directory structures for backend, frontend, shared code, tests, and infrastructure.
  • Automates the generation of matching test files, docstrings, type definitions, and infrastructure files (Docker, CI/CD).
  • Integrates security best practices, including authentication, error handling, and data protection.
  • Aims to identify and annotate technical debt, suggesting future optimizations.

Maintenance & Community

The project welcomes contributions via Pull Requests. The author, @TheRealPourya, can be followed on X for updates. No specific community channels (Discord, Slack) or roadmap links are provided in the README.

Licensing & Compatibility

The README does not specify a license. This absence may impose restrictions on use, particularly for commercial or closed-source projects, and requires clarification before adoption.

Limitations & Caveats

The effectiveness of this prompt is heavily dependent on the user's ability to define and maintain a clear, comprehensive ARCHITECTURE.md file. The prompt itself does not contain the architecture; it relies on external definition. Its success also hinges on the AI assistant's interpretation capabilities.

Health Check
Last Commit

2 weeks ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
2
Star History
330 stars in the last 18 days

Explore Similar Projects

Starred by Chip Huyen Chip Huyen(Author of "AI Engineering", "Designing Machine Learning Systems"), Joe Walnes Joe Walnes(Head of Experimental Projects at Stripe), and
5 more.

awesome-cursorrules by PatrickJS

0.5%
36k
Curated list of Cursor AI .cursorrules files for AI-powered code editor
Created 1 year ago
Updated 1 month ago
Feedback? Help us improve.