Readme updates for CLI & Expo #484
Conversation
Summary by CodeRabbit
WalkthroughThe pull request updates the project documentation and dependency configuration. The README now clearly distinguishes between the CLI and Expo apps, providing separate setup instructions, Git commands, and running instructions for each environment. Prerequisites have been revised, updating the required JDK to version 17 and Node.js to version 18. Additionally, the Changes
Poem
Tip ⚡🧪 Multi-step agentic review comment chat (experimental)
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: 6
🔭 Outside diff range comments (1)
README.md (1)
90-98: 🧹 Nitpick (assertive)Git Commands for Local CLI Setup
The Git instructions are straightforward and easy to follow. As an enhancement, ensure that the fenced code block is surrounded by blank lines and includes an appropriate language specifier (e.g., ```bash) to improve readability and conform with markdown best practices.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
92-92: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
README.md(6 hunks)package.json(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
47-47: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
48-48: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
59-59: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
61-61: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
62-62: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
62-62: Bare URL used
null
(MD034, no-bare-urls)
63-63: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
64-64: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
68-68: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
69-69: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
69-69: Bare URL used
null
(MD034, no-bare-urls)
70-70: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
71-71: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
72-72: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
73-73: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
100-100: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
101-101: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
101-101: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
129-129: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
131-131: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
132-132: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
133-133: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
135-135: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
137-137: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
138-138: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
139-139: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
🔇 Additional comments (2)
package.json (1)
119-122: Node Version Update VerifiedThe Volta configuration has been updated to use
"node": "18.18.0", which now aligns with the prerequisites described in the README. This update ensures consistency between the documentation and the toolchain requirements.README.md (1)
12-17: Enhanced Project Description and Migration ClarityThe updated section clearly describes that the repository now includes both a CLI app and an Expo app—and it explains the ongoing migration from React Native CLI to Expo. This added clarity helps users understand the dual setup.
| - JDK ( openjdk 17.0.13 2025-03-15 ) | ||
| - Node setup ( use version v18.*, tested on v18.18.0) |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Updated Prerequisites
The prerequisites now specify the updated JDK version (openjdk 17.0.13) and the Node setup (version v18.*, tested on v18.18.0). Consider using a consistent unordered list marker (asterisk) instead of dashes, as recommended by your markdown style guidelines.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
47-47: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
48-48: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
| ### Local App setup for CLI | ||
|
|
||
| - Set up your local environment for React Native following the environment setup guide. | ||
| - Clone the mobile app repository: git clone https://github.com/Real-Dev-Squad/mobile-app.git | ||
| - Set up your local environment for React Native CLI following the environment setup guide. | ||
| - Clone the mobile app repository from develop branch: git clone https://github.com/Real-Dev-Squad/mobile-app.git | ||
| - Run the command: `yarn` | ||
| - Start contributing! | ||
|
|
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Local App Setup for CLI
The step-by-step instructions for setting up the CLI app are clear and well organized. To further enhance consistency with the rest of the document, verify that the bullet list style conforms to your project’s markdown guidelines (preferably asterisks).
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
59-59: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
61-61: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
62-62: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
62-62: Bare URL used
null
(MD034, no-bare-urls)
63-63: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
64-64: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
| ### Local App setup for Expo | ||
|
|
||
| - Set up your local environment for React Native Expo following the environment setup guide. | ||
| - Clone the mobile app repository from develop branch: git clone https://github.com/Real-Dev-Squad/mobile-app.git | ||
| - Switch to the expo-migration branch | ||
| - Make sure you don't have metro.config.js and yarn.lock files from CLI project in expo-migration branch | ||
| - Change the directory to RDSExpoApp | ||
| - Create Yarn.lock file in RDSExpoApp folder | ||
| - Run the command: `yarn` | ||
| - Start contributing! | ||
|
|
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Local App Setup for Expo
The new section detailing the setup for the Expo app is comprehensive and clearly distinguishes itself from the CLI instructions. As with the CLI section, consider adopting a consistent bullet style (e.g., asterisks) to align with markdown best practices.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
68-68: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
69-69: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
69-69: Bare URL used
null
(MD034, no-bare-urls)
70-70: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
71-71: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
72-72: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
73-73: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
74-74: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
75-75: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
| ## Git commands for local Expo setup | ||
| ``` | ||
| git clone https://github.com/Real-Dev-Squad/mobile-app.git | ||
|
|
||
| cd RDSExpoApp | ||
|
|
||
| yarn | ||
|
|
||
|
|
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Git Commands for Local Expo Setup
The guidance here is clear. However, the inline instruction at line 105 (“- Make sure to remove conflicting CLI project files if present”) appears inside a code block. For clarity, consider prefixing this remark with a shell comment symbol (e.g., #) so that it’s not mistaken for an executable command. Additionally, adding a language specifier to the fenced code block would be beneficial.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
100-100: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
101-101: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
101-101: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
| **Running/Development for CLI** | ||
|
|
||
| - Start Metro (JavaScript bundler): `yarn react-native start` | ||
| - For Android: `yarn react-native run-android` | ||
| - For iOS: yarn `react-native run-ios` | ||
|
|
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Formatting Improvement for CLI Development Section
The section title "Running/Development for CLI" is currently styled with bold text. For better semantic clarity and consistency, consider converting it into a proper markdown heading (e.g., using ## Running/Development for CLI).
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
129-129: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
131-131: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
132-132: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
133-133: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
| **Running/Development for Expo** | ||
|
|
||
| - Start Metro bundler: `npx expo start` | ||
| - For Android: `npx expo run:android` | ||
| - For iOS: yarn `npx expo run:ios` | ||
|
|
||
| If the above commands fail, try building the Android app from Android Studio and the iOS app from Xcode. |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Formatting Improvement for Expo Development Section
Similarly, the "Running/Development for Expo" title would be more effective as a markdown heading rather than bold text. Using a heading format will improve the document’s structure and readability.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
135-135: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
137-137: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
138-138: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
139-139: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
2 participants
Date: 15-03-2025
Developer Name: @Aditys018
Issue Ticket Number
#482
Description
Updated readme for the proper setup of CLI and Expo projects, updated package.json to the latest required node version for the smooth functioning of CLI app
Documentation Updated?
Under Feature Flag
Database Changes
Breaking Changes
Development Tested?
Screenshots
Screenshot 1
Test Coverage
Screenshot 1
Additional Notes