fix: add missing dependencies to fix dev server and improve README local run explanation for Google config.#507
Conversation
|
@NicolasMontone is attempting to deploy a commit to the Zero Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThis pull request updates documentation formatting, enhances the clarity of setup instructions in the README, and adds additional spacing and rearrangement of content for better readability. It also introduces three new dependencies in the mail package and implements new database migration files: one SQL script for creating a Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant MF as Migration Framework
participant DB as Database
participant SM as Snapshot Manager
participant JM as Journal Manager
Dev->>MF: Initiate DB migration
MF->>DB: Execute SQL migration (create mail0_note)
DB-->>MF: Acknowledge table creation
MF->>SM: Update schema snapshot (JSON)
SM-->>MF: Snapshot updated
MF->>JM: Append migration entry to journal
JM-->>MF: Journal updated
Possibly related PRs
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
apps/mail/package.json (2)
73-73: New Dependency: "he" Addition
The dependency"he": "^1.2.0"has been added. Please verify that this version meets your project’s needs and does not conflict with other packages, especially regarding security advisories.
91-91: New Dependency: "react-use" Added
The dependency"react-use": "^17.6.0"is now included. Confirm that this version is compatible with your React setup and that its behavior aligns with your intended usage.README.md (2)
124-130: Troubleshooting Section Update
The troubleshooting section now includes a code block with commands to resolve dependency issues inside the container (removingnode_modulesand reinstalling). Consider adding a language specifier (e.g., ```bash) for these fenced code blocks to satisfy markdownlint rules and improve clarity.
260-261: Markdown Fenced Code Block Language Specifier
Static analysis has flagged that fenced code blocks (e.g., around line 261) should include a language specifier. Please update these blocks (for example, using ```bash for shell scripts) to enhance syntax highlighting and compliance with markdown guidelines.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
261-261: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
bun.lockis excluded by!**/*.lock
📒 Files selected for processing (5)
README.md(10 hunks)apps/mail/package.json(2 hunks)packages/db/migrations/0017_fluffy_sebastian_shaw.sql(1 hunks)packages/db/migrations/meta/0017_snapshot.json(1 hunks)packages/db/migrations/meta/_journal.json(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
261-261: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🔇 Additional comments (7)
apps/mail/package.json (1)
93-93: New Dependency: "react-wrap-balancer" Inclusion
The new dependency"react-wrap-balancer": "^1.1.1"has been added. Ensure that its functionality and version are as expected and that any necessary documentation updates (or usage examples) are provided.packages/db/migrations/meta/_journal.json (1)
111-130: Migration Journal Update: New Entry Added
A new journal entry withidx17 has been added. Please double-check that the timestamp and tagging (i.e."0017_fluffy_sebastian_shaw") are correct and consistent with your migration history.packages/db/migrations/0017_fluffy_sebastian_shaw.sql (1)
1-13: SQL Migration formail0_noteTable
The SQL migration correctly creates themail0_notetable with well-defined columns and defaults, followed by a foreign key constraint onuser_id. Confirm that the data types, default values, and constraint actions (i.e.ON DELETE cascadeandON UPDATE no action) match your intended database design and that the"statement-breakpoint"comment is temporary or intended for debugging purposes.README.md (3)
19-27: Enhanced Features List Formatting
The bullet list under "Why Zero?" has been reformatted into individual lines for better readability. This is a clear improvement in presentation—please ensure that the new format is consistent with the rest of the documentation.
64-74: Clarified Quick Start Instructions
Additional commands have been provided in the Quick Start Guide (e.g., after cloning, installing dependencies, and starting the database). These changes improve clarity for new users. Just verify that the command order and spacing are consistent and that any new instructions (likebun db:dependenciesandbun docker:up) are properly documented in related setup guides.
105-115: Improved Dev Container Setup Instructions
The prerequisites and steps for opening the project in a Dev Container have been updated (e.g., the cloning step and VS Code prompts). This should help ensure a smoother onboarding process for contributors using VS Code.packages/db/migrations/meta/0017_snapshot.json (1)
264-349: New Database Snapshot Entry formail0_note
The snapshot file now includes a detailed definition for themail0_notetable. The columns, defaults, and foreign key configuration (particularly for"mail0_note_user_id_mail0_user_id_fk") match the SQL migration. Please verify that the default value for thecolorcolumn (i.e."'default'") is formatted as intended and that all table definitions across the snapshot remain consistent with your latest schema changes.
|
Please revise, you pushed db files |
2 participants
Description
There were missing deps in package.json so when running it locally it started breaking
Type of Change
Please delete options that are not relevant.
Areas Affected
Please check all that apply:
Testing Done
Describe the tests you've done:
None
Checklist
Additional Notes
I leave the auto generated files like the snapshot and _meta.json since I saw that you were leaving them, I can remove it if it's necessary
Summary by CodeRabbit
Documentation
Chores
New Features