Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Epic 2.10 Frontend for Text Rewriter #191

Open
5 tasks
Ahmedr275 opened this issue Dec 4, 2024 · 3 comments
Open
5 tasks

Epic 2.10 Frontend for Text Rewriter #191

Ahmedr275 opened this issue Dec 4, 2024 · 3 comments
Labels
Blocked by Dependancy frontend This issue is primarly front-end focused good first issue Good for newcomers type:new-feature For proposals or implementation of entirely new features or functionalities.

Comments

@Ahmedr275
Copy link
Collaborator

Frontend Implementation: Text Rewriter Tool


Overview
Referring to Issue #128 for developing the Text Rewriter, the AI backend functionality has been implemented. This issue focuses on the frontend implementation to create an intuitive interface for users to rewrite text based on specific requirements, such as tone, style, or level of complexity.

Details from Backend Issue (#128):
The Text Rewriter tool allows users to input text or upload files, specify rewriting instructions, and generate revised text based on the provided criteria. The backend supports flexible inputs and generates high-quality outputs tailored to user requirements.


Scope of Work

  1. Tool Description
    The Text Rewriter tool will enable users to input text, define rewriting goals, and review AI-generated revisions interactively. Users will also have the option to export the revised text.

  2. Design Implementation
    The frontend should follow the provided design mockups to ensure a seamless and engaging user experience.
    Design Mockup

  3. API Integration

    • Use the backend API to process input text and retrieve rewritten versions based on user-defined criteria.
    • Ensure seamless interaction between the frontend and backend for data submission and output retrieval.
  4. Features to Implement

    • Input Form: Build a form where users can input text directly or upload files in supported formats (e.g., CSV, DOCX, PDF).
    • Rewrite Options: Allow users to define rewriting parameters such as tone, style, or simplification level.
    • Output Display: Present the rewritten text in a structured, editable format for review.
    • Export Functionality: Add options to export rewritten text as DOCX or PDF documents.
    • Validation: Implement input validation to ensure the data is complete and meets the format requirements.

Acceptance Criteria

  • The frontend matches the design mockup and provides a seamless user experience.
  • The input form captures user data accurately and sends it to the backend API.
  • Rewritten text is displayed in a clear and editable format for user review.
  • Export functionality (DOCX and PDF formats) works as expected.
  • The tool is responsive and functional across devices and browsers.

Resources

  1. Design Mockup
  2. Backend API Documentation
  3. Backend Issue (#128)

Notes
This issue depends on the backend implementation. Frontend developers should refer to the API documentation to test integration and ensure the rewritten outputs meet user expectations for clarity and usability.

@Ahmedr275 Ahmedr275 added good first issue Good for newcomers frontend This issue is primarly front-end focused type:new-feature For proposals or implementation of entirely new features or functionalities. labels Dec 4, 2024
@Ahmedr275 Ahmedr275 moved this to Todo in Issues board Dec 4, 2024
@ansen01-svg
Copy link

I think the backend implementation for this feature is missing.

@Ahmedr275
Copy link
Collaborator Author

@ansen01-svg , you are correct. I've updated the issue accordingly. For Frontend, Issues #187 , #188 , and #189 will be up first. There is a PR available on their AI-backend tickets.

@Passive-coder0
Copy link

@Ahmedr275 , Mr Ahmed, is the issue still available to work on?
If so, where is the file in the Marvel Platform folder,

And also could I get the resources like: the background, marvel logo, and icons?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Blocked by Dependancy frontend This issue is primarly front-end focused good first issue Good for newcomers type:new-feature For proposals or implementation of entirely new features or functionalities.
Projects
Status: Todo
Development

No branches or pull requests

3 participants