Skip to content

poap-xyz/poap.js

Repository files navigation

Warning

The POAP SDK is still in the active initial development phase. Anything MAY change at any time.

This is a Developer Preview aimed primarily at existing integrators to gather early feedback. Documentation is in progress.

This product is in development and is not intended to be used in a production environment.

If you want to collaborate and leave us feedback, you can do it so here

POAP.js

Build Status

The POAP.js is a collection of SDKs and utilities for interacting with the POAP ecosystem. The library provides a set of classes and methods to simplify working with it.

Table of Contents

Features

  • Handle moments creation and management
  • TypeScript support with strong typing
  • Easy integration with the POAP ecosystem

Development

To start developing the POAP Package Library, follow these steps:

  1. Clone the repository:
git clone https://github.com/poap-xyz/poap.js.git
  1. Have yarn installed:
npm install -g yarn
  1. Install dependencies:
yarn install
  1. Build the packages:
yarn build
  1. Run the tests:
yarn test

Documentation

You can find the documentation in this link: POAP.js Documentation

The documentation is located in the docs folder.

Contributing

Contributions to the POAP Package Library are welcome. To contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch with a descriptive name.
  3. Make your changes and commit them with a clear and concise commit message.
  4. Create a pull request, describing the changes you made and why.
  5. Wait for a maintainer to review your pull request and provide feedback.

Please ensure that your code adheres to the project's code style and passes all tests before submitting a pull request.

See CONTRIBUTING.md file for guidelines on how to get involved.

Active contributors


Rodrigo Manuel Navarro Lajous

💻

Agustin Lavarello

💻

Ignacio Negro Caino

💻

Fernando Martin

💻

Robin Gagnon

💻

License

MIT © POAP