everything sdk js

a javascript sdk for connecting applications, marketplaces, and services to the inventory of everything and its ecosystem.

learn more · report bug · request feature

about

everything is a framework for putting it all together; it provides methods for creating and querying data in both Web2 and Web3 in order to foster opinionated development of real world applications, marketplaces, and services for the interconnected economy of tomorrow.

SDK development funded by Mintbase Grant Program

(back to top)

usage

The methods provided in this SDK require Auth0 integration for connecting to everything and Mintbase integration for connected to NEAR Protocol.

Setting up Auth0

Follow the steps in Auth0 Documentation for your specific application.

IN PROGRESS: We are working to create a custom SSO login that can be available in development of your own apps to generate your own AUTH0_CLIENT_SECRET. Unfortunately, until then, the same AUTH0_CLIENT_SECRET must be shared across all participating applications. If you want to develop a participating application, please reach out to [email protected].

Setting up Mintbase

Follow the steps in Mintbase Documentation for your specific application.

Using the SDK

With Auth0 and Mintbase configured and integrated, you can now use the available SDK methods.

Visit the corresponding documentation:

Creating Things and Minting References

Creating Media and Associating Tagss

Reading Data

testing

Unit tests

1. Clone the repo
2. Install packages

npm install

3. Run tests (this will run tests from all packages)

npm test

Interactive testing (playground)

1. Run the Dockerfile

docker-compose up

This will automatically set up the environment, start any necessary mock services, and run the tests. View the terminal to see test results.

2. Open the playground in browser to interact with the SDK methods or query data

IN PROGRESS: Local is currently not connecting to the everything api because I don't want to move it to the mono repo... A live version of the app can be used here which is connected to test environemnt.

contributing

To run the project in development:

1. Clone the repository
2. Start the development playground and enable change watching and hot-reload.

npm run dev

3. Make changes, write tests, and then open a pull request for review.

Thanks for contributing!

license

distributed under the MIT License. see LICENSE for more information.

(back to top)