Skip to content

Readme updates for CLI & Expo #484

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.

Sign up for GitHub

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

Closed
konti-aditi wants to merge 1 commit into from
Closed

Readme updates for CLI & Expo #484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 42 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,15 @@ Welcome to the repository of our mobile app, which mirrors all the features of o
* React Native
* TypeScript
* StyleSheet

## About the Project

This project serves as the Real Dev Squad cross-platform mobile app, built using React Native.
This repository contains the Real Dev Squad cross-platform mobile app, built using React Native.
As we are currently migrating the app from React Native CLI to Expo, the repository includes two projects:

1. **CLI app**
2. **Expo app**

## First Phase

- Github Authentication ✅ (we did it via webview, requirement has changed to browser login from github)
Expand Down Expand Up @@ -38,8 +44,8 @@ To contribute, make sure you have the following:

- React Native setup
- Android Studio
- JDK ( openjdk 11.0.20.1 2023-08-24 )
- Node setup ( use version v16.*, tested on v16.20.2)
- JDK ( openjdk 17.0.13 2025-03-15 )
- Node setup ( use version v18.*, tested on v18.18.0)
Comment on lines +47 to +48
Copy link

@coderabbitai coderabbitai bot Mar 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 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)

- [Volta](https://docs.volta.sh/guide/getting-started) | [Why Volta?](https://docs.volta.sh/guide/#why-volta)
- React Native development environment set up
- Android Studio installed
Expand All @@ -50,10 +56,21 @@ To contribute, make sure you have the following:

For detailed setup instructions, refer to [React Native environment setup guide](https://reactnative.dev/docs/environment-setup).

### Local App setup
### 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!

Comment on lines +59 to +65
Copy link

@coderabbitai coderabbitai bot Mar 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 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!

Comment on lines +66 to 76
Copy link

@coderabbitai coderabbitai bot Mar 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 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)

Expand All @@ -70,7 +87,7 @@ To contribute to our project:
- If you need assistance, reach out on the mobile-app-react-native channel on Discord.


## Git commands for local setup
## Git commands for local CLI setup

```
git clone https://github.com/Real-Dev-Squad/mobile-app.git
Expand All @@ -80,6 +97,17 @@ cd mobile-app
yarn
```

## Git commands for local Expo setup
```
git clone https://github.com/Real-Dev-Squad/mobile-app.git

cd RDSExpoApp

yarn


Comment on lines +100 to +108
Copy link

@coderabbitai coderabbitai bot Mar 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 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)

```


## Git commands to commit your code:
```
Expand All @@ -98,10 +126,16 @@ git push origin your-PR-name

All PRs should have 100% test coverage. Before submitting PRs, run yarn test to ensure all tests pass.

**Running/Development**
**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`

Comment on lines +129 to 134
Copy link

@coderabbitai coderabbitai bot Mar 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 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.
Comment on lines +135 to 141
Copy link

@coderabbitai coderabbitai bot Mar 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 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 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@
]
},
"volta": {
"node": "18.0.0",
"node": "18.18.0",
"yarn": "1.22.19"
},
"engines": {
Expand Down
Loading