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

feat(note): add note mvp #4

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

feat(note): add note mvp #4

wants to merge 1 commit into from

Conversation

haloivanid
Copy link
Collaborator

@haloivanid haloivanid commented Oct 29, 2024

this PR will fix issue: #3

Summary by CodeRabbit

  • New Features

    • Introduced a new note management system with entities for Notes, NoteTransactions, NoteItems, NoteAccounts, and NoteMembers.
    • Enhanced tracking of financial transactions associated with notes.
  • Bug Fixes

    • Updated existing entities to maintain consistency and improve data integrity.
  • Documentation

    • Updated entity relationship diagrams to reflect new structures and relationships.
  • Chores

    • Added migration scripts to implement the new database schema for notes.

note is main feature of finote

#3
@haloivanid haloivanid added enhancement New feature or request good first issue Good for newcomers labels Oct 29, 2024
@haloivanid haloivanid self-assigned this Oct 29, 2024
Copy link

coderabbitai bot commented Oct 29, 2024

Walkthrough

The changes introduce a new database schema for managing notes and transactions within the application. This includes the addition of several new entities such as Note, NoteTransaction, NoteItem, NoteAccount, and NoteMember, each with defined attributes and relationships. Existing entities like User, Account, and UserSession have been updated to align with the new structure. The migration file implements the creation of these tables and their relationships, ensuring referential integrity within the database.

Changes

File Path Change Summary
server/.erd/erdiadb.json Added entities: Note, NoteTransaction, NoteItem, NoteAccount, NoteMember. Updated entities: User, Account, UserSession. Renamed AccountHistory to NoteItem. Added/modified various attributes and indexes.
server/.erd/mermaid.html Updated ERD to reflect new entities and relationships. Renamed account_history to note_item.
server/src/databases/entities/core/note-account.entity.ts Added NoteAccount class with foreign keys note_id and account_id, establishing relationships.
server/src/databases/entities/core/note-item.entity.ts Added NoteItem class with properties transaction_id, account_id, user_id, and others.
server/src/databases/entities/core/note-member.entity.ts Added NoteMember class with foreign keys note_id and user_id, establishing relationships.
server/src/databases/entities/core/note-transaction.entity.ts Added NoteTransaction class with properties for transaction details and relationships.
server/src/databases/entities/core/note.entity.ts Added Note class with properties name and description.
server/src/databases/migrations/1730203011356-note.ts Introduced migration file to create tables for note, note_member, note_transaction, note_item, and note_account. Defined foreign key constraints and rollback logic.

Poem

🐇 In the garden of notes, we now can play,
With transactions and members, we hop all day.
New entities bloom, like flowers in spring,
Each one a treasure, oh what joy they bring!
So let’s dance through the fields, with data so bright,
In our world of notes, everything feels right! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a64a19f and 234ef31.

📒 Files selected for processing (8)
  • server/.erd/erdiadb.json (50 hunks)
  • server/.erd/mermaid.html (6 hunks)
  • server/src/databases/entities/core/note-account.entity.ts (1 hunks)
  • server/src/databases/entities/core/note-item.entity.ts (1 hunks)
  • server/src/databases/entities/core/note-member.entity.ts (1 hunks)
  • server/src/databases/entities/core/note-transaction.entity.ts (1 hunks)
  • server/src/databases/entities/core/note.entity.ts (1 hunks)
  • server/src/databases/migrations/1730203011356-note.ts (1 hunks)

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@haloivanid haloivanid linked an issue Oct 29, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature] User Notes
1 participant