Permalink
Fetching contributors…
Cannot retrieve contributors at this time
154 lines (118 sloc) 6.44 KB

Getting Started with F2

The goal of F2 is to define a development standard for the financial services industry that offers a cost saving, risk-reducing method for building innovative, multi-provider solutions.

Below you'll find links to the various sections of the F2 development standard as well as F2.js API reference documentation.


F2 Container

For Container Providers

F2 Apps

For App Providers

API Reference

For Container and App Developers


Latest Version

The latest version of F2 is {{version}} which was released on {{_releaseDateFormatted}}.

F2 v1.0 was originally open sourced in October 2012. A detailed changelog and roadmap are available on GitHub.

<script src="https://gist.github.com/anonymous/3836902fbfbb14a7f186.js"></script>

Download version {{version}}


Examples

There are a few different types of examples available below.

Examples

Visit [openF2.org/examples](http://www.openf2.org/examples) for a live demo of production-grade Apps in a basic Container.

Download

A variety of example Containers and Apps to [download](http://docs.openf2.org/F2-examples.zip) and run on your localhost. Most are "plain" javascript, others are written in .NET, PHP and Node.js. The [examples source code is also on GitHub](https://github.com/OpenF2/F2/tree/master/examples).

jsFiddle

Review a collection of fiddles on [jsfiddle.net/user/openF2js](http://jsfiddle.net/user/OpenF2js/fiddles/).

Codepen

Review a collection of pens on [codepen.io/openF2](http://codepen.io/OpenF2/).

iOS Demo App

An [iOS app](http://openf2.github.io/iOS-Container/) demonstrating F2 App integration using UIWebViews, a javascript bridge for [F2 Context](container-development.html#context), and a native symbol search control.

Resources & Help

Have a question? Find a bug? Need help?

Guides

_Coming soon..._

GitHub Issues

Browse and submit to [Issues on GitHub](https://github.com/OpenF2/F2/issues) for bug reports, enhancement requests, etc.

Slack

Join the [F2 Slack](https://openf2.slack.com/) for real-time project updates. _[Get an invite](https://openf2-slack.herokuapp.com/)._

<script async defer src="//openf2-slack.herokuapp.com/slackin.js"></script>

OpenF2 Google Group

Use the F2 mailing list on [Google Groups](https://groups.google.com/forum/#!forum/OpenF2) for support.

Email

You can always email [info@openF2.org](mailto:info@openf2.org) with questions.

Specification

The F2 development standard will continuously evolve to bring the community the best features, services and apps. F2's promise is to do this by building on the existing spec, not by changing it. The specification aims high to solve many problems and suit many needs. As the standard evolves and new requirements come to light, the functionality in F2 will expand accordingly.

Notational Conventions

The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this spec are to be interpreted as described in RFC 2119. For readability, these words often do not appear in all uppercase letters.


Contribute to F2

Join our team and help contribute to F2 on GitHub. Begin by reading our contribution guidelines, and then start by forking the repo, sending pull requests, or submitting issues.

Thank you to the growing list of contributors!