Skip to content

Commit

Permalink
Add setup & tests guide
Browse files Browse the repository at this point in the history
  • Loading branch information
josefdolezal committed May 14, 2017
1 parent ca5b590 commit 6f60f90
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 8 deletions.
1 change: 0 additions & 1 deletion Cartfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ github "ReactiveCocoa/ReactiveSwift" ~> 1.0.1
github "ReactiveCocoa/ReactiveCocoa" ~> 5.0.0
github "Moya/Moya" ~> 8.0.2
github "SnapKit/SnapKit" ~> 3.2.0
github "socketio/socket.io-client-swift" ~> 9.0.0
43 changes: 36 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,41 @@
[![Build Status](https://travis-ci.com/3DprintFIT/octoprint-ios-client.svg?token=AxpSW7yys3aiQpPG9zMW&branch=dev)](https://travis-ci.com/3DprintFIT/octoprint-ios-client)
[![codebeat badge](https://codebeat.co/badges/f2a97050-74db-47c1-a050-daf71d57c7c9)](https://codebeat.co/projects/github-com-3dprintfit-octoprint-ios-client)
[![codecov](https://codecov.io/gh/3DprintFIT/octoprint-ios-client/branch/dev/graph/badge.svg)](https://codecov.io/gh/3DprintFIT/octoprint-ios-client)
# octoprint-ios-client [![Build Status](https://travis-ci.com/3DprintFIT/octoprint-ios-client.svg?token=AxpSW7yys3aiQpPG9zMW&branch=dev)](https://travis-ci.com/3DprintFIT/octoprint-ios-client) [![codebeat badge](https://codebeat.co/badges/f2a97050-74db-47c1-a050-daf71d57c7c9)](https://codebeat.co/projects/github-com-3dprintfit-octoprint-ios-client) [![codecov](https://codecov.io/gh/3DprintFIT/octoprint-ios-client/branch/dev/graph/badge.svg)](https://codecov.io/gh/3DprintFIT/octoprint-ios-client)

# octoprint-ios-client
## Setup

# Local usage
0. Install [Carthage](https://github.com/Carthage/Carthage) dependency manager
1. Install [SwiftLint](https://github.com/realm/SwiftLint) Swift linter
2. Install [SwiftGen](https://github.com/SwiftGen/SwiftGen) which generates translations
3. Run `$ carthage bootstrap --platform iOS`
4. Open `OctoPhone.xcodeproj`
5. :tada:

## Docker setup
## Tests

This project also contains tests.
These are located at [OctoPhoneTests](OctoPhoneTests) and are used to test ViewModel layer.
You can run tests in Xcode with `cmd + u` keyboard shortcut.

## Dependencies

This project is build with a huge help of its dependencies:

* [Realm](https://github.com/realm/realm-cocoa)
* [Alamofire](https://github.com/Alamofire/Alamofire)
* [ReactiveSwift](https://github.com/ReactiveCocoa/ReactiveSwift)
* [ReactiveCocoa](https://github.com/ReactiveCocoa/ReactiveCocoa)
* [Moya](https://github.com/Moya/Moya)
* [SnapKit](https://github.com/SnapKit/SnapKit)

github "realm/realm-cocoa" ~> 2.0
github "Alamofire/Alamofire" ~> 4.0
github "ReactiveCocoa/ReactiveSwift" ~> 1.0.1
github "ReactiveCocoa/ReactiveCocoa" ~> 5.0.0
github "Moya/Moya" ~> 8.0.2
github "SnapKit/SnapKit" ~> 3.2.0

## Local usage

### Docker setup

You can run octoprint in docker for testing purposes (on virtual printer). Simply run docker container:

Expand All @@ -19,7 +48,7 @@ Octoprint now runs on port `32768`.

App should be able to find your docker OctoPrint instance and connect to it.

### Login
#### Login

In docker container is test user called `octophone` with `octophone` password. There is pregenerated access token for your app:

Expand Down

0 comments on commit 6f60f90

Please sign in to comment.