### Install npm Dependencies and Run Local Server

Source: https://github.com/mojaloop/documentation/blob/master/README.md

Installs project dependencies and starts the local development server. Ensure npm is installed.

```bash
# install npm dependencies
npm ci 

# run the local server
npm run dev
```

--------------------------------

### Deploy Mojaloop Backend Dependencies

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/technical/deployment-guide/README.md

Installs the example Mojaloop backend dependencies chart. This is recommended for PoC, development, and testing purposes and should be deployed in a separate named deployment.

```bash
helm --namespace demo install backend mojaloop/example-mojaloop-backend --create-namespace
```

--------------------------------

### View TTK Hub Setup and Simulator Provisioning Logs

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/technical/deployment-guide/README.md

Retrieve logs for the TTK Hub setup and Simulator Provisioning test collection. This helps in diagnosing issues during the initial setup phase.

```bash
kubectl -n demo logs pod/moja-ml-ttk-test-setup
```

--------------------------------

### Install Mock Pathfinder Dependencies

Source: https://github.com/mojaloop/documentation/blob/master/docs/getting-started/technical-faqs.md

Run this command in the mock-pathfinder directory after downloading the repository to install necessary dependencies.

```bash
npm install
```

--------------------------------

### Example Helm Upgrade Command

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/technical/deployment-guide/upgrade-strategy-guide.md

An example of how to apply Helm upgrade parameters to upgrade a Mojaloop deployment.

```bash
helm --namespace ${NAMESPACE} ${RELEASE_NAME} upgrade --install mojaloop/mojaloop --reuse-values --version ${RELEASE_VERSION}
```

--------------------------------

### Install Third Party API Dependencies

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/technical/deployment-guide/README.md

Install Redis and MySQL for the auth-service, and MySQL for the consent oracle using kubectl apply.

```bash
# install redis and mysql for the auth-service
kubectl apply --namespace demo -f https://raw.githubusercontent.com/mojaloop/helm/master/thirdparty/chart-auth-svc/example_dependencies.yaml
# install mysql for the consent oracle
kubectl apply --namespace demo -f https://raw.githubusercontent.com/mojaloop/helm/master/thirdparty/chart-consent-oracle/example_dependencies.yaml
```

--------------------------------

### GET /config/schemas/

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/reference-architecture/boundedContexts/commonInterfaces/index.md

To get schema and current configurations of all bounded contexts.

```APIDOC
## GET /config/schemas/

### Description
Retrieves the schema and current configurations for all bounded contexts.

### Method
GET

### Endpoint
/config/schemas/
```

--------------------------------

### Install Mojaloop Services v17.0.0

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/technical/deployment-guide/upgrade-strategy-guide.md

Installs the Mojaloop services for version 17.0.0. Ensure the NAMESPACE and VALUES_FILE variables are set.

```bash
helm install moja mojaloop/mojaloop --namespace ${NAMESPACE} --version v17.0.0 -f ${VALUES_FILE}
```

--------------------------------

### Install KowL Kafka UI with Helm

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/business-operations-framework/ReportingBC.md

Install the KowL Kafka UI using Helm. Ensure you have the correct values file for your deployment.

```bash
helm repo add cloudhut https://raw.githubusercontent.com/cloudhut/charts/master/archives
helm repo update
helm install kowl cloudhut/kowl -f values-moja2-kowl-values.yaml
```

--------------------------------

### Install Latest Mojaloop Version

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/technical/deployment-guide/README.md

Installs the latest version of the Mojaloop Helm chart. The --create-namespace flag is only needed if the 'demo' namespace does not exist.

```bash
helm --namespace demo install moja mojaloop/mojaloop --create-namespace
```

--------------------------------

### Update and Install Dependencies

Source: https://github.com/mojaloop/documentation/blob/master/docs/community/standards/creating-new-features.md

Execute these commands to update and install project dependencies. Ensure to review any dependency changes for potential breaking changes.

```bash
npm run dep:update && npm i
```

--------------------------------

### Verify Helm Chart Installation

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/technical/deployment-guide/deployment-troubleshooting.md

Check if Mojaloop Helm charts are installed. If not, refer to the deployment guide for installation instructions.

```bash
helm list
```

--------------------------------

### Start Mock Backend and Scheme Adapter

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/technical/sdk-scheme-adapter/usage/scheme-adapter-and-local-k8s/README.md

Command to start the configured mock DFSP backend and SDK scheme adapter services using Docker Compose. Navigate to the 'src' directory before running.

```bash
cd src
docker-compose up -d
```

--------------------------------

### Initialize Terraform Backend and Apply

Source: https://github.com/mojaloop/documentation/blob/master/infra/README.md

Initializes the Terraform backend configuration for the documentation site and applies the infrastructure changes. This is typically done once.

```bash
cd ../src
# first time only 
terraform init \
  -backend-config="bucket=docs.mojaloop.io-state" \
  -backend-config="region=eu-west-2" \
  -backend-config="dynamodb_table=docs.mojaloop.io-lock"


# see what changes are needed
terraform plan

# apply the terraform
terraform apply
```

--------------------------------

### Successful Legacy Health Check Request

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/technical/central-ledger/admin-operations/1.0.0-get-health-check.md

This example shows a basic GET request to the /health endpoint without any query parameters, typically returning a simple status.

```bash
GET /health HTTP/1.1
Content-Type: application/json

200 SUCCESS
{
  "status": "OK"
}
```

--------------------------------

### Example URI with Query Parameters

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/api/fspiop/v1.1/api-definition.md

An example of a URI for the /authorization resource, demonstrating the use of multiple key-value pairs in the query string separated by ampersands.

```text
/authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102&currency=USD
```

--------------------------------

### Successful Detailed Health Check Request

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/technical/central-ledger/admin-operations/1.0.0-get-health-check.md

This example demonstrates a GET request to the /health endpoint with the 'detailed=true' query parameter, which returns comprehensive health information including service dependencies.

```bash
GET /health?detailed=true HTTP/1.1
Content-Type: application/json

200 SUCCESS
{
  "status": "OK",
  "uptime": 0,
  "started": "2019-05-31T05:09:25.409Z",
  "versionNumber": "5.2.3",
  "services": [
    {
      "name": "broker",
      "status": "OK"
    }
  ]
}
```

--------------------------------

### Deploy Preview to S3

Source: https://github.com/mojaloop/documentation/blob/master/README.md

Manually deploys the documentation preview to an S3 bucket. Requires AWS CLI, AWS access, and aws-mfa to be configured.

```bash
./scripts/_deploy_preview_s3.sh
```

--------------------------------

### Install npm-check-updates

Source: https://github.com/mojaloop/documentation/blob/master/docs/community/standards/guide.md

Install npm-check-updates as a development dependency for managing NodeJS project dependencies.

```bash
npm install -D npm-check-updates
```

--------------------------------

### Install Mojaloop Services v16.0.0 for Testing

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/technical/deployment-guide/upgrade-strategy-guide.md

Installs Mojaloop services for version 16.0.0 and runs tests to populate databases. Ensure NAMESPACE and VALUES_FILE are set.

```bash
helm --namespace ${NAMESPACE} install ${RELEASE} mojaloop/mojaloop --version 16.0.0  -f ${VALUES_FILE}
```

--------------------------------

### GET /config/schemas/:boundedContextId

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/reference-architecture/boundedContexts/commonInterfaces/index.md

To get schema and current configurations of a specific bounded context.

```APIDOC
## GET /config/schemas/:boundedContextId

### Description
Retrieves the schema and current configurations for a specific bounded context.

### Method
GET

### Endpoint
/config/schemas/:boundedContextId

### Parameters
#### Path Parameters
- **boundedContextId** (string) - Required - The ID of the bounded context.
```

--------------------------------

### Example BinaryString Value

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/api/fspiop/json-binding-rules.md

Provides an example of a valid BinaryString value, which is a base64url encoded string.

```string
AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9Ig
```

--------------------------------

### Install audit-ci

Source: https://github.com/mojaloop/documentation/blob/master/docs/community/standards/guide.md

Install audit-ci as a development dependency for performing security audits on NodeJS project dependencies.

```bash
npm install -D audit-ci
```

--------------------------------

### Start Minikube Cluster

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/business-operations-framework/ReportDeveloperGuide.md

Initiates a local Kubernetes cluster using Minikube with Docker as the driver and a specific Kubernetes version. Ensure Docker is running.

```bash
minikube start --driver=docker --kubernetes-version=v1.21.5
```

--------------------------------

### Install Backend Dependencies v16.0.0 with Persistence

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/technical/deployment-guide/upgrade-strategy-guide.md

Installs backend dependencies for version 16.0.0 with persistence enabled. Manual database creation is required as initDb scripts will not run. Ensure NAMESPACE and VALUES_FILE are set.

```bash
helm --namespace ${NAMESPACE} install ${RELEASE} mojaloop/example-mojaloop-backend --version 16.0.0  -f ${VALUES_FILE}
```

--------------------------------

### BinaryString32 Example

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/api/fspiop/logical-data-model.md

Example of a BinaryString32, which is a base64url encoded string representing 32 bytes of data without padding.

```text
QmlsbCAmIE1lbGluZGEgR2F0ZXMgRm91bmRhdGlvbiE
```

--------------------------------

### Full License and Contributors Header Example

Source: https://github.com/mojaloop/documentation/blob/master/docs/community/contributing/pr-guidance.md

This example shows the complete license and contributors header for a Mojaloop file, including the format for indicating AI assistance for a contributor.

```java
/*****
 License
 --------------
 Copyright © 2026 Mojaloop Foundation

 The Mojaloop files are made available by the Mojaloop Foundation under the Apache License, Version 2.0
 (the "License") and you may not use these files except in compliance with the [License](http://www.apache.org/licenses/LICENSE-2.0).

 You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)

 Unless required by applicable law or agreed to in writing, the Mojaloop files are 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](http://www.apache.org/licenses/LICENSE-2.0).

 Contributors
 --------------
 This is the official list of the Mojaloop project contributors for this file.
 Names of the original copyright holders (individuals or organizations)
 should be listed with a '*' in the first column. People who have
 contributed from an organization can be listed under the organization
 that actually holds the copyright for their contributions (see the
 Mojaloop Foundation organization for an example). Those individuals should have
 their names indented and be marked with a '-'. Email address can be added
 optionally within square brackets <email>.

 * Mojaloop Foundation
 - James Bush <jbush@mojaloop.io> [Assisted by Claude Sonnet 4.6]

 --------------
 ******/

```

--------------------------------

### Example instance of AuthenticationInfo complex type

Source: https://github.com/mojaloop/documentation/blob/master/docs/technical/api/fspiop/json-binding-rules.md

Provides an example of a valid 'AuthenticationInfo' object using the 'OAUTH2' type.

```json
{
  "type": "OAUTH2",
  "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}
```