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

Updates README, jdk+node version and setup steps for android and iOS #461

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
42 changes: 23 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
## Real Dev Squad Mobile App

Welcome to the repository of our mobile app, which mirrors all the features of our web applications.

## Tech Stack

* React Native
* TypeScript
* StyleSheet
- React Native
- TypeScript
- StyleSheet

## About the Project

This project serves as the Real Dev Squad cross-platform mobile app, built using React Native.

## First Phase

- Github Authentication ✅ (we did it via webview, requirement has changed to browser login from github)
Expand All @@ -21,6 +24,7 @@ This project serves as the Real Dev Squad cross-platform mobile app, built using
- API integration in Profile Screen ✅

## Second Phase

- Three Screens - Home , Goals and Profile ✅
- Home screen Features ✅
- Goals site Tab
Expand All @@ -30,16 +34,14 @@ Feel free to download our RDS app by clicking on ➡️ [RDS App](https://drive.

**Note** : Please delete the previous RDS app build if you have.


## Prerequisites


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.12" 2024-07-16 )
- Node setup ( use version above v18.8*, tested on v20.18*)
- [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 @@ -48,7 +50,7 @@ To contribute, make sure you have the following:

# **NOTE** : Make sure to set up the proper development environment required to run Hello world app in RN and drop a video link in #react-native channel.

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

### Local App setup

Expand All @@ -57,6 +59,18 @@ For detailed setup instructions, refer to [React Native environment setup guide
- Run the command: `yarn`
- Start contributing!

### Simulator / Physical device running setup

![alt text](image.png)

- Start the server as shown above by `yarn start` command.
- Open Android Studio to launch the Android simulator, or alternatively, connect a physical device via USB.
- Press `a` for Android or `i` for iOS to initiate a build that deploys the app to the simulator or connected device.
- If the commands do not work as expected, try building the Android app using Android Studio and the iOS app using Xcode.
- For further assistance, reach out on the `#mobile-app-react-native` channel on Discord.

Happy contributing! 😊

## Contribution Guide

To contribute to our project:
Expand All @@ -69,7 +83,6 @@ To contribute to our project:
- Push your code to your branch.
- If you need assistance, reach out on the mobile-app-react-native channel on Discord.


## Git commands for local setup

```
Expand All @@ -80,8 +93,8 @@ cd mobile-app
yarn
```


## Git commands to commit your code:

```
git checkout -b 'your-PR-name'

Expand All @@ -93,15 +106,6 @@ git push origin your-PR-name

```


## Test-Driven Development (TDD)

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

**Running/Development**

- Start Metro (JavaScript bundler): `yarn react-native start`
- For Android: `yarn react-native run-android`
- For iOS: yarn `react-native run-ios`

If the above commands fail, try building the Android app from Android Studio and the iOS app from Xcode.
Binary file added image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "RdsApp",
"name": "realdevsquad-mobile",
Ayushsanjdev marked this conversation as resolved.
Show resolved Hide resolved
"version": "0.0.1",
"private": true,
"scripts": {
Expand Down Expand Up @@ -118,7 +118,7 @@
]
},
"volta": {
"node": "18.0.0",
"node": "20.18.0",
"yarn": "1.22.19"
},
"engines": {
Expand Down