This repository has been archived by the owner on Jan 21, 2024. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Edit readme and installation instructions (#15)
* readme edits * readme edits
- Loading branch information
1 parent
ae0be49
commit 85c349a
Showing
2 changed files
with
58 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,84 +1,94 @@ | ||
## DreamHouse iOS App (ReactNative + Salesforce MobileSDK). | ||
# DreamHouse React Native Mobile App | ||
|
||
![iOS Screenshot](/README_files/screen2.png?raw=true) ![iOS Screenshot](/README_files/screen1.png?raw=true) | ||
|
||
### Attention: This is an experimental project published under ForceDotComLabs: | ||
React Native iOS implementation of the DreamHouse mobile app. DreamHouse is an end-to-end sample application that demonstrates how to build apps on the Salesforce platform. Visit the [DreamHouse Microsite](http://www.dreamhouseapp.io) for more information. | ||
|
||
1. work in progress | ||
2. we need your feedback | ||
3. code contributions are welcome | ||
This version of the application is built with React Native and the Salesforce Mobile SDK, including some new [experimental features](https://github.com/ForceDotComLabs/react.force.datacontainer) to generate parts of the UI using Salesforce metadata. | ||
|
||
### Step-by-step Tutorial | ||
This is an experimental project published under ForceDotComLabs, which means that: | ||
|
||
[ ![iOS Screenshot](/tutorial_video/README_files/video2.png?raw=true) ](/tutorial/) | ||
1. It's work in progress | ||
1. We need your feedback | ||
1. Code contributions are welcome | ||
|
||
### Org and Data setup: | ||
![iOS Screenshot](/README_files/screen2.png?raw=true) ![iOS Screenshot](/README_files/screen1.png?raw=true) | ||
|
||
Follow installation instructions at [dreamhouse micro-site](http://dreamhouse-site.herokuapp.com/installation/) | ||
## TrailheaDX Presentation | ||
|
||
### Project Setup | ||
Watch the recording of the presentation delivered at the TrailheaDX conference: | ||
|
||
1. npm dependencies: | ||
[![iOS Screenshot](tutorial_video/README_files/video2.png?raw=true)](https://www.youtube.com/watch?v=RY2vn2bT6XU) | ||
|
||
``` | ||
## Installation Instructions | ||
|
||
npm install | ||
1. Follow [these instructions](http://dreamhouse-site.herokuapp.com/installation/) to install the Salesforce back-end. | ||
|
||
``` | ||
1. Clone this repository: | ||
``` | ||
git clone https://github.com/ForceDotComLabs/dreamhouse-mobile-react | ||
``` | ||
|
||
2. cocoapods dependencies: | ||
1. Navigate to the `dreamhouse-mobile-react` directory: | ||
``` | ||
cd dreamhouse-mobile-react | ||
``` | ||
|
||
``` | ||
1. Install the npm dependencies: | ||
``` | ||
npm install | ||
``` | ||
|
||
pod install | ||
1. Install the cocoapods dependencies: | ||
``` | ||
pod install | ||
``` | ||
|
||
``` | ||
If the `pod` command is not found, install cocoapods first: | ||
``` | ||
sudo gem install cocoapods | ||
``` | ||
|
||
3. if [RNPM](http://facebook.github.io/react-native/releases/0.24/docs/linking-libraries-ios.html#automatic-linking) is not yet installed: | ||
If the installation of cocoapods fails, you may need to upgrade the version of ruby installed on your system. | ||
|
||
``` | ||
|
||
npm install rnpm -g | ||
1. Install [rnpm](http://facebook.github.io/react-native/releases/0.24/docs/linking-libraries-ios.html#automatic-linking) if it's not yet installed on your system: | ||
``` | ||
npm install rnpm -g | ||
``` | ||
|
||
``` | ||
4. link dependencies: | ||
1. Link dependencies: | ||
``` | ||
rnpm link | ||
``` | ||
|
||
``` | ||
## Run in the iOS Emulator | ||
|
||
rnpm link | ||
1. Type the following command to open the project workspace in Xcode: | ||
``` | ||
open dreamhouse.xcworkspace | ||
``` | ||
|
||
1. Start the development server: | ||
``` | ||
|
||
### Run | ||
|
||
1. Open the project workspace in Xcode: | ||
|
||
npm start | ||
``` | ||
|
||
open ./dreamhouse.xcworkspace | ||
``` | ||
1. in Xcode, select a phone to emulate and click **Run** | ||
|
||
2. Start development server: | ||
## Run on Device | ||
|
||
1. Start the development server: | ||
``` | ||
npm start | ||
``` | ||
|
||
3. Click `Run` in Xcode | ||
|
||
1. In Xcode, select the **dreamhouse** project in the Project Navigator and select the **dreamhouse copy** target. | ||
|
||
![xcode](README_files/xcode_target.jpg) | ||
|
||
### Running on device: | ||
1. Specify a **Bundle Identifier** and a **Team** corresponding to a provisioning profile you created in the Apple Developer Portal. | ||
|
||
1. Start: | ||
1. Select your phone in the device selector in the toolbar, and click **Run**. | ||
|
||
``` | ||
npm start | ||
``` | ||
## Step-By-Step Tutorial | ||
|
||
2. Choose `dreamhouse copy` target in Xcode and click `Run` | ||
Follow [this step-by-step tutorial](/tutorial) to recreate the application from scratch. |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.