Fuse SDK
Fuse is a configuration-driven tool developed by Appfire to help users set up and manage infrastructure and application deployment on AWS. Designed to streamline the deployment process in multi-account and multi-environment AWS setups, Fuse provides configurations for creating and managing resources like Lambda functions, API Gateways, DynamoDB tables, SQS queues, EKS, VPC, ElastiCache and more.
Fuse offers both Serverless and Managed Compute (Non-Serverless) options for infrastructure creation. Refer to the links below for more information.
| Framework | Description | Documentation |
|---|---|---|
| Fuse serverless framework | Fuse is a configuration-driven tool developed by Appfire to help users set up and manage infrastructure and application deployment on AWS. | Docs |
| Fuse managed compute | Fuse provides robust support for containerized applications using managed compute powered by AWS EKS. | Docs |
Pre-requisites
Install the packages listed below by clicking on the respective links.
| Tool | Description | Installation Link |
|---|---|---|
| pnpm | A fast and disk-efficient package manager for JavaScript and TypeScript, optimized for monorepos. Please use version 8.9.2, as the latest version of pnpm breaks the current lock file, and the pipeline still relies on 8.9.2. | Install pnpm |
| JQ | A command-line JSON processor that helps with parsing, filtering, and manipulating JSON data. | Install JQ |
| Volta | A JavaScript tool manager that ensures seamless switching between Node.js and package versions. | Install Volta |
| Turbo | A high-performance build system for JavaScript and monorepos, enabling efficient caching and parallel execution. | Install Turbo |
📌 What’s in This Repository?
This repository is a monorepo that houses all Fuse-related Infrastructure as Code (IaC), helper tools, utilities, and reference applications.
📌 Structure for Fuse
The table below outlines the key components available in Fuse:
| Folder | Description | Link |
|---|---|---|
| IaC packages | Includes Fuse IaC functionality both V1 and V2. | View packages |
| Helpers and Utilities | Includes various helper and utility packages that extend Fuse's functionality. These contain reusable internal libraries and it includes V1 and V2 | View Packages |
| Ref apps for V2 | Reference application for Fuse V2 | View Ref apps |
| Ref apps for V1 | Contains supporting tools, reference applications, and example implementations to help with Fuse-related development. | View apps |
This structure ensures better organization and maintainability, making it easier to find and manage Fuse-related tools and applications.
How do I get set up?
- Clone the repository
- Install the required packages using
pnpm install. Make sure you have installed pnpm version8.9.2 - You can find README for each package in their respective folders.
📦 Adding New Packages to the Repo
In a pnpm-based monorepo, you can install packages at different levels based on your requirements. Below are the different ways to install packages within the workspace.
🔧 Installation Commands
| Installation Type | Command | Description |
|---|---|---|
| Workspace Level | pnpm i <package_name> -w | Installs a package at the root of the workspace, making it available to all projects. |
| Specific Directory | pnpm install @appfire/helpers --filter "./<directory_name>/*" | Installs a package within a specific directory inside the workspace. |
| Specific Application | pnpm i <package_name> --filter "<workspace_app_name>" | Installs a package only for a specific app within the workspace. |
| Specific App (Scoped) | pnpm install @appfire/helpers --filter "@appfire/fuse-cdk-iac" | Installs a package for a specific app using its package scope. |
These commands ensure efficient dependency management within the pnpm workspace while keeping package installations modular and optimized.
Adding new Library or Application
We have a sample application lib-template. We will use it to create a new app.
- Run the following command to generate new library in desired folder
cp -R _templates/lib <path_to_new_lib>
- once its done. Change the directory to newly created library and update its
name from
@appfire/lib-templateto Preferred name
Release Process Documentation
Check here the documentation for Release Process
Contribution guidelines
- Writing tests
- Based on the type of changes (Major, Minor, or Patch), use changeset to
update. For more details on managing versions with
changeset, please check here
Who do I talk to?
For any questions or support, reach out to the Fuse team via the Slack channel. #help-fuse-app-framework