Merge commit 'refs/pull/372/head' of github.com:apache/usergrid into two-dot-o-dev
tree: cb59b1b638e146633f52cd0044fce5c5e4a6e64d
  1. .gitattributes
  2. .gitignore
  3. .usergridversion
  4. CHANGELOG
  5. LICENSE
  6. NOTICE
  7. README.md
  8. chop/
  9. content/
  10. docs/
  11. portal/
  12. release/
  13. sdks/
  14. stack/
  15. ugc/
  16. website/
README.md

Apache Usergrid

WARNING: This is the two-dot-o branch and work is underway here on a new persistence system for Usergrid. We refer to the new persistence system as Core Persistence and you can find its modules in the stack/corepersistence directory.

Overview

Apache Usergrid is a multi-tenant Backend-as-a-Service stack for web & mobile applications, based on RESTful APIs.

##Contributing We accept all contributions via our GitHub, so you can fork our repo (apache/usergrid) and then submit a PR back to us for approval. For larger PRs you'll need to have an ICLA form on file with Apache. For more information see our Contribution Workflow Policy, and specifically our External Contributors Guide.

##Build awesome apps with Usergrid!

Apache Usergrid provides all code necessary to build and power modern mobile applications. This includes the server stack, administrative portal website, SDKs in most popular languages, as well as command line tools.

Look for much more detailed README files in their corresponding subdirectories, or check out our website for more info.

  • The server-side stack, a Java 7 + Cassandra codebase that powers all of the features, is located under /stack. You can install dependencies and compile it with maven. See stack/README.md for instructions.

  • The admin portal is a pure HTML5+JavaScript app allowing you to register developers and let them manage their apps in a multi-tenant cluster. Located under /portal

  • SDKs for iOS, Android, HTML5/JavaScript, node.js, Ruby on Rails, pure Ruby, PHP, (server-side) Java, .Net / Windows, and Perl, located in their respective subdirectories under /sdks.

  • a command-line client “ugc” allowing you to complete most maintenance tasks, as well as queries in a manner similar to the mysql or the mongo shell, located under /ugc. You can install it on your machine with a simple sudo gem install ugc

##For more information See the Apache Usergrid web site.