jsundquist / f2

Redefining web integration for the financial services community

An open web framework for the financial services industry.

F2 is an open and free web integration framework designed to help the financial services community develop custom web and mobile applications. These solutions can combine the best tools and content from multiple parties into one, privately-labeled, seamlessly integrated front-end.

F2 is currently maintained by Markit On Demand. Visit OpenF2.org for more information, follow @OpenF2 on Twitter and subscribe to the F2 blog.

Get Started

Two core components of F2 are containers and apps which are stitched together by F2.js. Get started by browsing to the framework documentation at docs.openf2.org.

Developers

Get F2.js

• Production: F2.js (34.3kb, minified and gzipped)
• Development: F2.debug.js
• F2.js packages are also available, including F2.basic.js (7kb, minified and gzipped)
• We have CDN support—get F2.js and any packages on cdnjs.com.
• For .NET developers: install the NuGet Package.

Get Examples

Example containers and apps can be found in at least two places: openf2.org/examples and in the downloadable F2 examples zip archive. There are also numerous jsFiddles available in the documentation. This repository contains examples, too.

• Clone this repository using git clone [email protected]:OpenF2/F2.git, or
• Download the latest version of this repository

Docs

We have robust documentation divided into three main sections:

• Understanding the Basics
• Developing apps, containers, or F2 plugins.
• F2.js API

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!

Setup

Be sure you have cloned this repository and have Node.js installed, then run the following command from the project root directory:

$> npm install

This command will install the Grunt CLI in addition to all dependencies needed to build F2. Depending on your configuration, you may need to be an admin to install some of these Node packages. Additionally, some packages may need to be installed globally using the -g switch. If the installation fails due to directory permissions, use:

$> sudo npm install

We are using markitdown, a lightweight pandoc wrapper, for converting markdown files to HTML for the F2 docs. Pandoc is required for markitdown and there are installation packages available for Windows and Mac OS.

Build F2

To compile F2.js and the accompanying docs, run:

$> grunt

For help and a list of available grunt tasks, run:

$> grunt --help

Versioning

The latest version of F2.js will always be in master and the version number/release date is available on the command line by using:

$> grunt version.

In accordance with industry standards, F2 is currently maintained, in as far as reasonably possible, under the Semantic Versioning guidelines. Releases will be numbered with the following format:

<major>.<minor>.<patch>

For more information on SemVer, please visit SemVer.org.

Upgrading

It is our goal to make upgrading to the latest version of F2 a minor effort for development teams. Read more in the Docs.

Issues, Enhancements, Bugs

Have a question? Find a bug? Open an Issue on GitHub, post a topic on the Google Group or send an email to [email protected].

To track bugs, issues and enhancement requests, we are using Issues on GitHub.

Copyright and License

Copyright © 2014 Markit On Demand, Inc.

"F2" is licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Please note that F2 ("Software") may contain third party material that Markit On Demand Inc. has a license to use and include within the Software (the "Third Party Material"). A list of the software comprising the Third Party Material and the terms and conditions under which such Third Party Material is distributed are reproduced in the ThirdPartyMaterial.md file. The inclusion of the Third Party Material in the Software does not grant, provide nor result in you having acquiring any rights whatsoever, other than as stipulated in the terms and conditions related to the specific Third Party Material, if any.