Code Monkey home page Code Monkey logo

mobile's Introduction

Toggl Mobile

This repository contains the source code for building the native Toggl Android and iOS applications. These applications are build using Xamarin products to allow for maximum code reuse and faster development times.

Repository structure

The repository consists of the following projects:

  • Phoebe - shared data models and business logic across platforms
  • Joey - Android application (UI & Android specific code)
  • Ross - iOS application (UI & iOS specific code)
  • Tests - unit tests for testing code in Phoebe

Phoebe has several project files (Phoebe.Android.csproj, Phoebe.iOS.csproj and Phoebe.Desktop.csproj) which compile the same code for different target platforms (Android, iOS and desktop).

Setting up

You should begin by initializing git submodules we reference:

$ git submodule init
$ git submodule update

We use some NuGet packages, so you need to install an addin for Xamarin Studio: installation instructions. After successfully installing the addin, you need to right click on the solution and select "Restore NuGet Packages".

Before compiling any of the projects, there is one last file you need to edit. Phoebe/Build.cs contains various configuration parameters for different components, which you need to fill in for the app to run.

Contributing

Want to contribute? Great! Just fork the project, make your changes and submit a pull request.

Code style

We're lazy, so instead of having official coding style, we have a Xamarin Studio code formatting settings. And our IDEs configured to automatically format the file when saving.

If you plan on contributing it's best to have the same settings. You can copy the Default.mdpolicy.xml to ~/Library/XamarinStudio-4.0/Policies/ directory (on OSX).

Then make sure that you have "Custom" policy selected under Xamarin Studio settings > Source Code > Code Formatting > C# source code. And don't forget to turn on "Format document on save" under Xamarin Studio settings > Text Editor > Behavior.

We are hiring!

Want to write open source code for a living? Love writing mobile applications using Xamarin technologies? Sick of the daily commute to the office?

Check out our jobs page for the Xamarin/.NET mobile developer position.

License

The code in this repository is licensed under the BSD 3-clause license.

mobile's People

Contributors

roosmaa avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.