feat(backend): adding backend requirement document #52
+243
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds the necessary code changes to generate a UX Data Map document. The `UXDatamapHandler` class is introduced, which implements the `BuildHandler` interface. It includes a `run` method that generates the UX Data Map document based on the provided context data. The `UXDatamapHandler` class uses the `prompts.generateUXDataMapPrompt` function to dynamically generate the UX Data Map prompt. The prompt includes information such as the project name, sitemap documentation, and platform. The generated UX Data Map document is stored in the context using the `setData` method, with the key `uxDatamapDocument`. This feature enhances the project builder functionality by providing a way to generate a UX Data Map document, which helps in analyzing data requirements from a user experience perspective. Co-authored-by: Jackson Chen <541898146chen@gmail.com>
…base schema This commit adds the necessary code changes to generate the Database Requirements Document and the corresponding database schema. It introduces the `DBRequirementDocumentHandler` class, which implements the `BuildHandler` interface. The `run` method in this class generates the Database Requirements Document based on the provided context data. Additionally, the commit includes the `DBSchemaHandler` class, which is responsible for generating the database schema. It uses the `markdown-to-txt` library to convert the Markdown content of the Database Requirements Document into plain text, which is then used to generate the schema. These features enhance the project builder functionality by providing the ability to generate the Database Requirements Document and the database schema, ensuring a clear understanding of the database structure and requirements. Co-authored-by: Jackson Chen <541898146chen@gmail.com>
…ts Document This commit introduces the `BackendRequirementHandler` class, which implements the `BuildHandler` interface. The `run` method in this class generates the Backend Requirements Document based on the provided context data. The Backend Requirements Document includes the system overview, API endpoints, and implementation details. It provides guidelines for designing a clear system architecture, defining necessary API endpoints, and following RESTful or GraphQL conventions. The document also covers implementation details for request handlers/controllers, business logic layer/services, data access layer, and middleware components. This feature enhances the project builder functionality by providing the ability to generate a comprehensive Backend Requirements Document, ensuring a clear understanding of the backend system architecture and API endpoints. Co-authored-by: Jackson Chen <541898146chen@gmail.com>
|
Caution Review failedThe pull request is closed. WalkthroughA new class Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 eslint
backend/src/build-system/node/backend-requirements-document/index.tsOops! Something went wrong! :( ESLint: 8.57.1 ESLint couldn't find the plugin "eslint-plugin-prettier". (The package "eslint-plugin-prettier" was not found when loaded as a Node module from the directory "/backend".) It's likely that the plugin isn't installed correctly. Try reinstalling by running the following: The plugin "eslint-plugin-prettier" was referenced from the config file in "backend/.eslintrc.js". If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team. Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
This commit refactors the code for generating the Backend Requirements Document. It introduces the `BackendRequirementHandler` class, which implements the `BuildHandler` interface. The `run` method in this class generates the Backend Requirements Document based on the provided context data. The Backend Requirements Document includes the system overview, API endpoints, and implementation details. It provides guidelines for designing a clear system architecture, defining necessary API endpoints, and following RESTful or GraphQL conventions. The document also covers implementation details for request handlers/controllers, business logic layer/services, data access layer, and middleware components. This refactoring improves the project builder functionality by separating the logic for generating the Backend Requirements Document into a dedicated class, making the code more modular and maintainable. Co-authored-by: Jackson Chen <541898146chen@gmail.com>
ZHallen122
approved these changes
Nov 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Handler Input: The Backend Requirements Handler accepts a database requirements document along with technology stack specifications (language, framework, and packages) to generate backend implementation documentation.
Step 1 Prompt (Overview): Generates system architecture overview and API endpoint specifications based on database requirements, defining the complete API interface and project structure.
Step 2 Prompt (Implementation): Generates detailed implementation requirements including controllers, services, security, and error handling patterns based on the overview from Step 1.
Summary by CodeRabbit
New Features
BackendRequirementHandlerclass for generating Backend Requirements Documents.Bug Fixes
uxGoalsin theUXDatamapHandler, streamlining the process.These changes enhance the document generation capabilities and improve the overall efficiency of backend requirements handling.