General Framework Documentation

Introduction #

The NovaFacies Open Source Framework is a collaborative initiative aimed at revolutionizing the Financial Technology landscape. The framework provides a comprehensive platform for building, integrating, and scaling financial applications, fostering innovation and collaboration within the FinTech community.

The framework consists of two key components:

Guidelines: A structured set of best practices, interoperability standards, and development methodologies for FinTech applications. These guidelines ensure consistency, efficiency, and security in the development process.
Implementation: A flexible approach that supports both classic code development and modern paradigms like low-code/no-code platforms and Backend-as-a-Service (BaaS) solutions. This allows organizations to leverage the latest technologies and accelerate their time-to-market.

This document, the general Framework Documentation, serves as the master documentation.

Target Audience #

This documentation is intended for:

Developers: Building and implementing FinTech applications using NFF.
Architects: Designing and planning FinTech systems based on NFF.
System Administrators: Deploying and managing NFF-based applications.
Business Analysts: Understanding the capabilities and potential of NFF for FinTech solutions.

Documentation Principles #

Clarity: The documentation is written in clear and concise language, avoiding unnecessary jargon.
Accuracy: The information provided is accurate and up-to-date.
Completeness: The documentation covers all aspects of the framework, from architecture to implementation.
Accessibility: The documentation is easy to navigate and access, with clear structure and search functionality.

Document Organization #

The NFF documentation is organized into the following categories:

General Framework Documentation: This document provides an overview of the framework, its goals, architecture, and guiding principles. This is the document.
Architectural Overview: This document outlines the general architecture of an NFF-based solution while maintaining flexibility for different deployment models.
API Reference: Detailed documentation of the NFF API, including endpoints, request/response formats, and Authentication mechanisms.
Module Documentation: Documentation of the different modules within NFF, their functionalities, and implementation considerations.
Implementation Guides: Guides on how to implement NFF using different technologies and approaches.
Operational Documentation: Guidance on deploying, managing, and monitoring NFF-based applications.
Front-End Documentation: Guidelines and resources for building user interfaces for NFF applications.
Legal and Compliance: Information on licensing, terms of service, privacy policy, and compliance with industry regulations.
Testing & Quality Assurance: Defines best practices for ensuring the reliability, security, and compliance of NovaFacies implementations. Covers API testing, security testing (OWASP, penetration tests), performance/load testing, and compliance validation.
Deployment & Operations Guide: Outlines key operational considerations for deploying and maintaining an NFF-based system. Includes CI/CD pipelines, monitoring & observability, high availability & disaster recovery, and security hardening.
Integration & Interoperability Guidelines: Provides recommendations for ensuring smooth integrations with third-party services and financial systems. Covers API standardization (OpenAPI, JSON Schema), event-driven architectures, and best practices for third-party banking API integrations.
Compliance & Regulatory Guidelines: Ensures that implementations follow relevant financial regulations and security standards. Includes PSD2, GDPR, PCI-DSS compliance checklists, audit & logging requirements, and guidance for regulatory sandbox testing.
Roadmap & Future Development: Outlines the long-term vision and planned updates for the NovaFacies framework. Covers upcoming features, planned compliance updates, community-driven priorities, and growth of the open-source ecosystem.