Update README.md #380
Update README.md #380
Conversation
Added production mode and Windows changes
|
@glenviewjeff is attempting to deploy a commit to the Inbox Zero Team on Vercel. A member of the Team first needs to authorize it. |
|
|
WalkthroughThe pull request updates the instructions in the README file for running the application locally. The document now differentiates between developer mode (noted as slower) and production mode, introducing new commands for building ( Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Terminal
participant App
%% Developer Mode Flow
User->>Terminal: Run dev command (e.g., "npm start")
Terminal->>App: Launch app in developer mode (slower)
%% Production Mode Flow
User->>Terminal: Run "pnpm run build"
Terminal->>Terminal: Execute build process
User->>Terminal: Run "pnpm start"
Terminal->>App: Launch app in production mode (faster)
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://cdn.statically.io/img/avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
156-158: Windows Build Note: Minor Formatting NitpickThe note for Windows users is helpful. However, please consider removing the extra trailing space after
cross-env(i.e. fromcross-envtocross-env) to ensure consistency and avoid potential command‐parsing issues. Additionally, address any potential punctuation concerns as flagged by static analysis.🧰 Tools
🪛 LanguageTool
[uncategorized] ~156-~156: Possible missing comma found.
Context: ...pendingcross-envto the appropriate line as follows: `"build": "cross-env NODE_...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
156-156: Spaces inside code span elements
null(MD038, no-space-in-code)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~156-~156: Possible missing comma found.
Context: ...pending cross-env to the appropriate line as follows: `"build": "cross-env NODE_...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
README.md
156-156: Spaces inside code span elements
null
(MD038, no-space-in-code)
🔇 Additional comments (2)
README.md (2)
139-144: Developer Mode Instructions Look GoodThe instructions for running the application in developer mode (slower) and the associated command (
pnpm run dev) are clear and correctly placed.
151-155: Production Mode Instructions Are ClearThe newly added production mode commands (
pnpm run buildandpnpm start) correctly distinguish the faster production workflow. The placement and formatting within the code block are appropriate.
|
Thanks! |
|
Added cross-env to the command so others don't need to do it! Thanks for the contribution! |
Added production mode and Windows changes
Summary by CodeRabbit