Giter VIP home page Giter VIP logo

townespace-sdk's Introduction

SDK for TowneSpace

![AIP-pr][github-image] Discord NPM Package Version NPM Package Downloads

Description: The TowneSpace TypeScript SDK allows developers to interact with townespace smart contract including minting and composibility.

Installation

For use in Node.js or a web application
npm install townespace

You can also use yarn or pnpm.

For use in a browser
<script src="https://unpkg.com/townesquare@latest/dist/index.global.js" />

the SDK can then be accessed through window.townesquareSDK.

Documentation and examples

  • The Townesquare documentation site provides step-by-step instructions, code snippets, and best practices to use this library.
  • For in-depth examples, check out the examples folder with ready-made package.json files to get you going quickly!

Testing

To run the full SDK tests, From the root of this package, run:

npm test

If you see strange behavior regarding HTTP clients, try running the tests with --detectOpenHandles.

To test a single file in the SDK, From the root of this package, run:

npx jest -- <path/to/file.test.ts>

To use the local build in a local project:

// run from the root of this package
npm build
// run on your local project
npm add PATH_TO_LOCAL_SDK_PACKAGE

Contributing

If you found a bug or would like to request a feature, please file an issue. If, based on the discussion on an issue you would like to offer a code change, please make a pull request. If neither of these describes what you would like to contribute, checkout out the contributing guide.

TODO: add links

townespace-sdk's People

Contributors

aladeenb avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.