open-index/open-npm huggingface dataset:
npm package: @materia-dex/materia-contracts-distributor
Description: A smart contract that distributes a balance of tokens according to a merkle root
Author: materia
Latest version: 1.0.4

# @materia-dex/materia-contracts-distributor

# Local Development

The following assumes the use of `node@>=10`.

## Install Dependencies

`yarn`

## Compile Contracts

`yarn compile`

## Generate Merkle Tree

`yarn generate-merkle-root --input ../materia-retroqueries/results/airdrop.json > merkle.json`

## Run Tests

`yarn test`
npm package: @materia-dex/quickswap-sdk
Description: 🛠 An SDK for building applications on top of Quickswap.
Latest version: 3.1.1

# QuickSwap SDK

This repository has been forked from [UniswapV2](https://github.com/Uniswap/uniswap-sdk)

## Running tests

To run the tests, follow these steps. You must have at least node v10 and [yarn](https://yarnpkg.com/) installed.

First clone the repository:

```sh
git clone https://github.com/QuickSwap/QuickSwap-sdk.git
```

Move into the quickswap-sdk working directory

```sh
cd QuickSwap-sdk/
```

Install dependencies

```sh
yarn install
```

Run tests

```sh
yarn test
```

You should see output like the following:

```sh
yarn run v1.22.4
$ tsdx test
 PASS  test/constants.test.ts
 PASS  test/pair.test.ts
 PASS  test/fraction.test.ts
 PASS  test/miscellaneous.test.ts
 PASS  test/entities.test.ts
 PASS  test/trade.test.ts

Test Suites: 1 skipped, 6 passed, 6 of 7 total
Tests:       3 skipped, 82 passed, 85 total
Snapshots:   0 total
Time:        5.091s
Ran all test suites.
✨  Done in 6.61s.
```
npm package: @materia-dex/sdk-polygon
Description: An SDK for building applications on top of Materia.
Author: materia
Latest version: 1.6.7

# Materia SDK

[![npm](https://img.shields.io/npm/v/@materia-dex/sdk)](https://unpkg.com/@materia-dex/sdk@latest/)

## Running tests

To run the tests, follow these steps. You must have at least node v10 and [yarn](https://yarnpkg.com/) installed.

First clone the repository:

```sh
git clone https://github.com/Materia-dex/materia-sdk.git
```

Move into the materia-sdk working directory

```sh
cd materia-sdk/
```

Install dependencies

```sh
yarn install
```

Run tests

```sh
yarn test
```

You should see output like the following:

```sh
yarn run v1.22.4
$ tsdx test
 PASS  test/constants.test.ts
 PASS  test/pair.test.ts
 PASS  test/fraction.test.ts
 PASS  test/miscellaneous.test.ts
 PASS  test/entities.test.ts
 PASS  test/trade.test.ts

Test Suites: 1 skipped, 6 passed, 6 of 7 total
Tests:       3 skipped, 82 passed, 85 total
Snapshots:   0 total
Time:        5.091s
Ran all test suites.
✨  Done in 6.61s.
```
npm package: @materia/addon-boilerplate
Description: Starter kit to create a Materia Addon
Author: team@getmateria.com
Latest version: 1.1.2

# Materia - Addon Boilerplate

Starter kit to create a Materia Addon.

## Features

- Minimal server
- Default addon view (Angular v9 + Angular Material)
- **Custom setup dialog**
- Build system (@angular/cli + ng-packagr + TypeScript + Sass)

## Installation from NPM

In your Materia application, run `yarn add @materia/addon-boilerplate`

Restart Materia Designer

## Installation from local files

Clone this repository:

```
git clone git@github.com:thyb/materia-addon-boilerplate.git
cd materia-addon-boilerplate
```

Then install dependencies and build:

```
yarn
yarn build
```

To test your addon locally before publishing it to NPM, use `npm link`:

```
cd dist && npm link
```

and in your materia application

```
npm link @materia/addon-boilerplate
```

then add `"@materia/addon-boilerplate": "^1.1.0"` in the dependencies of the package.json - it will let Materia knows of the existance of the addon.
npm package: @materia/angular-universal
Description: Use Server Side Rendering with angular in your materia applications
Author: jean-marc.roy@getmateria.com
Latest version: 1.1.2

# Materia - Angular Universal

Enable Server Side Rendering for your angular application

## Features

- Extend Materia Server express app with @nguniversal

## Installation from NPM

In your Materia application, run `yarn add @materia/angular-universal` or `npm install @materia/angular-universal --save`

Restart Materia Designer

## Installation from local files

Clone this repository:

```
git clone git@github.com:geoastronaute/materia-angular-universal.git
cd materia-angular-universal
```

Then install dependencies and build:

```
yarn
yarn build:prod
```

To test your addon locally before publishing it to NPM, use `npm link` or `yarn link`:

```
cd dist && npm link
```

and in your materia application

```
npm link @materia/angular-universal
```

then add `"@materia/angular-universal"` in the links array of your materia.json config file - it will let Materia knows of the existance of the linked addon.
npm package: @materia/aws-s3
Description: Upload files to Amazon Web Service S3
Author: team@getmateria.com
Latest version: 1.1.2

# Materia - AWS S3

Use your AWS S3 account in your materia applications to upload and retrieve files. This addon uses the `aws-sdk` package under the hood.

## Prerequisites

You need a AWS account to use this addon.

## Features

- AWS S3 Buckets management: list/create/delete/listObject/deleteObject,
- AWS S3 endpoints management: add interactively upload, fetch and delete endpoints.

## Installation from NPM

In your Materia application, run `npm install @materia/aws-s3 --save` or `yarn add @materia/aws-s3`.

Materia Designer will automatically restart.

## Installation from local files

Clone this repository:

```
git clone git@github.com:materiahq/materia-aws-s3.git
cd materia-aws-s3
```

Then install dependencies and build:

```
yarn
yarn build
```

To test your addon locally before publishing it to NPM, use `npm link`:

```
cd dist && npm link
```

and in your materia application

```
npm link @materia/aws-s3
```

then add `"@materia/aws-s3"` in the links array of the materia.json configuration file - it will let Materia knows of the existance of the addon.
npm package: @materia/facebook
Description: Integrate Facebook connect to your Materia applications
Author: team@getmateria.com
Latest version: 1.1.2

# Materia - Facebook Addon

Integrate Facebook connect to your Materia applications

## Features

- Generate the endpoint to signin your users with Facebook (works in addition of @materia/users addon)

## Installation from NPM

In your Materia application, run `yarn add @materia/facebook`

Restart Materia Designer

## Installation from local files

Clone this repository:

```
git clone git@github.com:materiahq/materia-facebook.git
cd materia-facebook
```

Then install dependencies and build:

```
yarn
yarn build:prod
```

then, in your application, you can install the materia-facebook dist folder:

```
yarn add /path/to/materia-facebook/dist
```
npm package: @materia/firebase-authentication
Description: Manage and identify your Firebase users in your Materia applications
Author: team@getmateria.com
Latest version: 1.1.2

# Materia - Addon Firebase Authentication

Manage and identify your Firebase users in your Materia Application backend. 

This addon uses firebase-admin npm package under the hood.

## Use case

If you are using Firebase Authentication on your client app and need to identitfy currently signed-in user server side.

## Features

- List/Create/Update/Delete your firebase users
- Permission to Verify ID Tokens: retrieve your user Firebase unique ID from your sign-in user ID Token

## Installation from NPM

In your Materia application, run `npm install @materia/firebase-authentication` or `yarn add @materia/firebase-authentication`

Restart Materia Designer

## Installation from local files

Clone this repository:

```
git clone git@github.com:materiahq/materia-firebase-authentication.git
cd materia-firebase-authentication
```

Then install dependencies and build:

```
yarn
yarn build

or

npm install
npm run build
```

To test your addon locally before publishing it to NPM, use `npm link` or `yarn link`:

```
cd dist && npm link
```

and in your materia application

```
npm link @materia/firebase-authentication
```

then add `"@materia/firebase-authentication"` in the links array of the materia.json configuration file - it will let Materia knows of the existance of the addon.
npm package: @materia/local-uploader
Description: Upload files with multipart/form-data
Author: team@getmateria.com
Latest version: 1.1.2

# Materia - Local Uploader

Upload Files to your materia application folder, through multipart/form-data.

Warning: This addon is not scallable.

## Features

- Add interactively "Upload Endpoints" to your application with available permissions and options: maxFileSize, MIME types accepted...
- List of uploaded files

## Installation from NPM

In your Materia application, run `npm install @materia/local-uploader --save` or `yarn add @materia/local-uploader`

Restart Materia Designer

## Installation from local files

Clone this repository:

```
git clone git@github.com:thyb/materia-local-uploader.git
cd materia-local-uploader
```

Then install dependencies and build:

```
yarn
yarn build
```

To test your addon locally before publishing it to NPM, use `npm link`:

```
cd dist && npm link
```

and in your materia application

```
npm link @materia/local-uploader
```

then add `"@materia/local-uploader"` in the links array of the materia.json configuration file - it will let Materia knows of the existance of the addon.
npm package: @materia/mailjet
Description: Emailing Materia addon to send email in your application using Mailjet
Author: team@getmateria.com
Latest version: 1.1.3

# Materia - Addon Mailjet

Send emails in your materia applications with your mailjet account. This addon uses node-mailjet under the hood.

## Prerequisites

You need a Mailjet account to use this addon.

## Features

- Send simple emails or templates
- Statistics for your Mailjet ApiKey
- Manage your Mailjet contacts

## Installation from NPM

In your Materia application, run `npm install @materia/mailjet` or `yarn add @materia/mailjet`

Restart Materia Designer

## Installation from local files

Clone this repository:

```
git clone git@github.com:materiahq/materia-mailjet.git
cd materia-mailjet
```

Then install dependencies and build:

```
yarn
yarn build
```

To test your addon locally before publishing it to NPM, use `npm link`:

```
cd dist && npm link
```

and in your materia application

```
npm link @materia/mailjet
```

then add `"@materia/mailjet"` in the links array of the materia.json configuration file - it will let Materia knows of the existance of the addon.
npm package: @materia/schematics-addons
Description: Schematics to manage Materia Addons
Author: team@getmateria.com
Latest version: 1.1.1

# Getting Started @materia/schematics-addons

This package is used to generate a Materia Addon automatically using Angular schematics.

To use it you will need to:
 - install `@angular-devkit/schematics-cli` globally and use the `schematics` command line tool,
 - install `@materia/schematics-addons` globally.


Run following command with npm:
 ```bash
npm install -g @angular-devkit/schematics-cli @materia/schematics-addons
```
or using yarn:
 ```bash
yarn global add @angular-devkit/schematics-cli @materia/schematics-addons
```

### Generate a new addon

Run this comand in the folder where you want to generate your new addon folder:

```bash
schematics @materia/schematics-addons:new --name=ADDON_NAME --packageName=PACKAGE_NAME --prefix=COMPONENT_PREFIX 
```

All params are optional:
- name: Name of your addon (default: 'addon-boilerplate'),
- prefix: Prefix used in angular for the client side part (default: 'materia'),
- packageName: Name used in package.json if different from name.