F2 is an open and free web integration framework designed to help the financial services community develop custom solutions that combine the best tools and content from multiple parties into one, privately-labeled, seamlessly integrated front-end. The essential components core to the framework are containers, apps, context, and the Registry—all supported under the hood by F2.js, a JavaScript SDK which provides an extensible foundation powering all F2-enabled web applications.
F2 is currently maintained by Markit On Demand. Visit OpenF2.org for more information and follow @OpenF2 on Twitter.
Clone the repo, git clone https://github.com/OpenF2/F2.git, or download the latest version.
Browse to the Get Started documentation for containers or apps.
- Development: F2.debug.js
- Production: F2.js (34.3kb)
Important: If you just want to develop F2 containers or apps, you can skip the section below. You do not need the command line, Node.js or Grunt to develop with F2.
Packages are variants of F2.js. They are ideally used when, for example, a container already has jQuery or sandboxed apps aren't needed. Read more about F2 packages.
- Basic:
- Development: F2.basic.js
- Production: F2.basic.min.js (7.6kb)
- No easyXDM:
- Development: f2.no-easyXDM.js
- Production: f2.no-easyXDM.min.js (30.4kb)
- No Bootstrap:
- Development: F2.no-bootstrap.js
- Production: F2.no-bootstrap.min.js (33.6kb)
- No jQuery, Bootstrap:
- Development: f2.no-jquery-or-bootstrap.js
- Production: f2.no-jquery-or-bootstrap.min.js (11.5kb)
For those contributing to F2, you'll need to setup your dev environment. To configure it, be sure you 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.
To build F2, run:
$> grunt
For help and a list of available tasks, run:
$> grunt --help
Some Mac users have run into a Grunt "cannot run in wd" error when using grunt and/or npm install. If you're getting that error in your shell, try using --unsafe-perm as discussed here.
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.
It is our goal to make upgrading to the latest version of F2 a minor effort for development teams. For more notes on upgrading your container or app to the latest version of F2, read more in the Docs.
Have a question? Want to chat? Open an Issue on GitHub, ask it on our Google Group or send an email to [email protected].
To track bugs, issues and enhancement requests, we are using Issues on GitHub.
Good news if you're using C#! We have an F2 NuGet package available. In your Package Manager Console run:
PM> Install-Package 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!
Copyright © 2013 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.