DHaire92 / Flash-Cardio

0 stars 1 forks source link

Firebase rework #5

Closed lvngstn closed 2 weeks ago

lvngstn commented 2 weeks ago

Summary by Sourcery

Rework the Firebase integration by introducing a FolderEdit component and enhancing the folder management features in the Editor page. Update the project documentation with a new guide detailing the project structure.

New Features:

Enhancements:

Documentation:

sourcery-ai[bot] commented 2 weeks ago

Reviewer's Guide by Sourcery

This pull request implements a Firebase rework, focusing on improving the folder and flashcard management functionality in the Editor component. The changes include the addition of a new FolderEdit component, modifications to the UI for adding cards and folders, and updates to the folder creation and management logic.

User journey diagram for updated folder and flashcard management

journey
    title User Journey for Folder and Flashcard Management
    section Folder Management
      User ->> Editor: Click 'Create New from Current'
      User ->> Editor: Click 'Save'
      User ->> Editor: Click 'Folder' in AddCard
      User ->> Editor: Interact with FolderEdit
    section Flashcard Management
      User ->> Editor: Click 'Card' in AddCard
      User ->> Editor: Update flashcard front
      User ->> Editor: Update flashcard back
      User ->> Editor: Delete flashcard

File-Level Changes

Change Details Files
Added FolderEdit component and modified folder management UI
  • Imported FolderEdit component
  • Removed 'Create New from Current' button
  • Added new AddCard component for folders
  • Included FolderEdit component in the UI
client/src/pages/Editor.js
Updated flashcard rendering and management
  • Modified Flashcard component props
  • Updated AddCard component usage
client/src/pages/Editor.js
Improved CSS styling for better UI appearance
  • Added styling for folder edit icon container
  • Removed transition duration from add-card hover effect
client/src/pages/Editor.css
client/src/components/flashcard/add-card/AddCard.css
Simplified Button component logic
  • Removed unnecessary comment in onClick handler
client/src/components/button/Button.js
Enhanced folder creation process
  • Added comment about adding Firestore UUID to folder object
  • Updated folder creation logic to include ID assignment
client/src/pages/Home.js
Added project documentation
  • Created Project-Guide.md with detailed project structure information
client/Project-Guide.md

Tips and commands #### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).