Skip to main content

Fuse SDK

Pre-requisites​

Install packages listed below by clicking on the respective link

  1. pnpm - https://pnpm.io/installation
  2. JQ - https://github.com/stedolan/jq
  3. Volta - https://volta.sh

Home to all the fuse SDK(s) as below

  1. CDK
  2. CLI
  3. Libs

What is this repository for?​

A monorepo for all Fuse SDK(s). you can find all the SDK applications under folder apps and we also have few of the packages (Helpers/Utilities) under folder packages

How do I get set up?​

Installation​

We will be using pnpm instead of npm and volta as node version manager. Run the following command for installing dependencies.

We are also using turbo repo as a build system to run Builds, Lints and Tests.

Adding packages​

For installing Packages at workspace level, run the following command

pnpm i <axios_this_is_example> -w

For installing Packages at a specific application, run the following command

pnpm i <axios_this_is_example> --filter "<workspace_app_name>"

For installing workspace at a specific directory, run the following command

pnpm install @appfire/helpers --filter "./<directory_name>/*"

for specific app

pnpm install @appfire/helpers --filter "@appfire/fuse-cdk-iac"

Adding new Library​

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-template to Preferred name

Release Process Documentation

Check here the documentation for Release Process

Contribution guidelines​

  • Writing tests
  • Based on type of changes (Major, Minor, and Patch) use changeset to update package versions. for more information please check here

Who do I talk to?​