Skip to content
This repository has been archived by the owner on Dec 5, 2019. It is now read-only.

aerogear-attic/aerogear-xamarin-sdk

Repository files navigation

AeroGear Xamarin SDK

Current Build : Build status

.Net and Xamarin libraries for the AeroGear Mobile Core

Project Info
License: Apache License, Version 2.0
Build: MSBuild
Documentation: TBD
Issue tracker: https://issues.jboss.org/browse/AEROGEAR
Mailing lists: aerogear-users
aerogear-dev

Documentation

  1. End User Getting Started Guide
  2. SDK architecture
  3. NuGet distributing
  4. Development Guide

List of SDKs

AeroGear Services SDK consist of set of separate SDKs

  • Core: Common base for all SDKs
  • Auth: Mobile authentication SDK

License

See LICENSE file

Development

If you would like to help develop AeroGear you can join our developer's mailing list, join #aerogear on Freenode, or shout at us on Twitter @aerogears.

Generate API Docs

The API docs are generated using Doxygen.

  1. Install Doxygen following the instructions

  2. Locate the doxygen command line tool.

    • For Mac, if Doxygen is installed in /Applications, you can find the command line tool in /Applications/Doxygen.app/Contents/Resources/doxygen
  3. To generate the API docs, run the command line tool in the root of the SDK directory:

    cd aerogear-xamarin-sdk
    # on Mac, run this command
    /Applications/Doxygen.app/Contents/Resources/doxygen docs/Doxyfile

    The generated files can be found in the Documentations directory.

  4. To add more directories for API doc generation, update the INPUT configuration in the Doxygen configuration file. Use spaces to separate the files or directories.

Testing

Use Visual Studio for Windows Test Explorer (Test > Windows > Test Explorer) or Visual Studio for Mac (View > Test).

You can run tests also from the Developer Command Line (in Windows).

msbuild Core\Tests\Core.Tests.csproj /t:Test 

Questions

Join our user mailing list for any questions or help! We really hope you enjoy app development with AeroGear!

Found a bug?

If you found a bug please create a ticket for us on Jira with some steps to reproduce it.