habitica-ios's Introduction

Habitica for iOS

Native iOS app for Habitica.

Contributing

For an introduction to the technologies used and how the software is organized, refer to Contributing to Habitica - "Coders (Web & Mobile)" section.

Thank you very much to all contributors.

Steps for contributing to this repository:

Fork it
Create your feature branch: git checkout -b my-new-feature
Commit your changes: git commit -am 'Add some feature'
Push to the branch: git push origin my-new-feature
Create new Pull Request

Don't forget to include your Habitica User ID, so that we can count your contributrion towards your contributor tier

Setup for local development

Config File

Copy over the sample debug config file.

$ cp sample.debug.xcconfig debug.xcconfig

If you want to run your app against a locally running version of Habitica, change CUSTOM_DOMAIN to localhost:3000 or whatever port you have your local version configured to. Also set DISABLE_SSL to true so that the url can be configured correctly.

CocoaPods

We are using CocoaPods to manage dependencies.

If you have managed ruby environment (rbenv, rvm, etc.):

$ bundle install
$ bundle exec pod install

As an alternative, it is possible to install the dependendencies manually. Use sudo if required to install gems (i.e. you are using the MacOS system ruby):

$ sudo gem install cocoapods:'>=1.2'
$ sudo gem install cocoapods-keys
$ pod install

During installation, cocoapods-keys will prompt for some of the keys used in the project. Use any random value for debugging, the real values are only required when uploading a final build to the app store.

CocoaPods requires that you open the Habitica.xcworkspace.