Skip to content
This repository has been archived by the owner on Jun 7, 2020. It is now read-only.

[FIX] Updated development environment setup instructions #2575

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

[FIX] Updated development environment setup instructions #2575

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3bc1593
Updated development environment setup instructions
prateekguptaiiitk Mar 12, 2019
c0994bf
Merge pull request #1 from RocketChat/develop
prateekguptaiiitk Jun 2, 2019
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
29 changes: 23 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,33 @@ In case you're interested in playing around with the code or giving something ba
1. A macOS machine
2. Xcode 9.3.x or higher (Swift 4.1)

### Installing dependencies
Before you begin, you should already have the Xcode downloaded and set up correctly. You can find a guide on how to do this here: [Setting up Xcode](https://developer.apple.com/xcode/)

_(NOTE: Steps 3 and 4 must be executed from project's directory)_
### Development Setup

1. Clone this repo:
#####        Steps to install Cocoapods (one time installation)

- Run `sudo gem install cocoapods` to install the latest version of cocoapods. To install cocoapods from HomeBrew, `brew install cocoapods`.

- Next, run `pod setup` for setting up cocoapods master repo.

### Setting up the iOS Project

1. Download the _Rocket.Chat.iOS_ project source. You can do this either by forking and cloning the repository (recommended if you plan on pushing changes) or by downloading it as a ZIP file and extracting it. OR
```
git clone https://github.com/RocketChat/Rocket.Chat.iOS
$ git clone https://github.com/RocketChat/Rocket.Chat.iOS
```
2. Use the Rocket.Chat.xcworkspace file to open the Xcode workspace.
3. Build the project by ⌘ + R

2. Navigate to the unzipped folder and run the following commands-</br>
`pod deintegrate`</br>
Copy link
Contributor

Choose a reason for hiding this comment

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

@prateekguptaiiitk Why deintegrate is necessary here?

Copy link
Author

Choose a reason for hiding this comment

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

pod deintegrate helps to remove all traces of Cocoapods from the project. So after that if we do pod install we can start to install them afresh. pod update will solve any version inconsistencies. Without pod deintegrate project was throwing random build errors.

Copy link
Contributor

Choose a reason for hiding this comment

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

@prateekguptaiiitk pod update will cause the CocoaPods to update libraries even if they're not in the same version as in Podfile.lock, right? It could cause some inconsistencies between projects in this case I think. Just pod install should be enough for anyone cloning the project, but most of the time that's not even necessary because the Pods folder is already being cloned.

Have you experienced any problems cloning the app for the first time and running it?

Copy link
Author

Choose a reason for hiding this comment

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

Yes @rafaelks I along with some others experienced problems while setting up the project for the first time and running it. Even running pod install didn't help. When I ran pod deintegrate and then pod install my problem was resolved and project was built successfully.

Copy link
Contributor

Choose a reason for hiding this comment

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

While I didn't experience any problem setting up the project for the first time, as the Pods were already there, I think the problem is usually with updating swiftlint and fastlane.

`pod install`</br>
`pod update`</br>

3. Open `Rocket.Chat.xcworkspace` from the folder.

4. Build the project (⌘+B) and check for any errors.

5. Run the app (⌘+R).and test it.

Also refer to [Guidelines](#project.pbxproj) for modifying files.

Expand Down