@builddao/near-social-js

NEAR Social SDK

A JavaScript SDK for interacting with the social contract (social.near) with helper functions for typical social features.

Table of contents

• 1. Overview
• 2. Documentation
• 3. Development
  • 3.1. Requirements
  • 3.2. Setup
  • 3.3. Build
• 4. Appendix
  • 4.1. Useful Commands
  • 4.2. Social Contract
• 5. How To Contribute
• 6. License

🔭 1. Overview

TBC...

^{Back to top ^}

📚 2. Documentation

For full documentation, please see here.

^{Back to top ^}

🛠 3. Development

3.1. Requirements

• Install Node v18.20.2+
• Install Yarn v1.22.5+

^{Back to top ^}

3.2. Setup

1. Install the dependencies:

$ yarn install

^{Back to top ^}

3.3. Build

• To build simply run:

$ yarn build

The above command will compile the Typescript source code into a dist/ directory.

^{Back to top ^}

📑 4. Appendix

4.1. Useful Commands

Command	Description
yarn build	Builds the source code into the dist/ directory.
yarn docs:build	Builds the documentation into the .docusaurus/ directory.
yarn docs:serve	Serves the built documentation from the .docusaurus/ directory.
yarn docs:start	Builds and runs the documentation in a development environment with hot reloading.
yarn lint	Runs the linter on .js and .ts files.
yarn node:start	Starts up a NEAR development node in a background process.
yarn node:start	Stops the NEAR development node that was started in yarn node:start.
yarn prettier	Runs the prettier on .js and .ts files.
yarn test	Starts a NEAR development node and runs the tests.

^{Back to top ^}

4.2. Social Contract

Network	Account ID	Link
Mainnet	social.near	https://nearblocks.io/address/social.near
Testnet	v1.social08.testnet	https://testnet.nearblocks.io/address/v1.social08.testnet

^{Back to top ^}

👏 5. How To Contribute

Please read the Contributing Guide to learn about the development process.

^{Back to top ^}

📄 6. License

Please refer to the LICENSE file.

^{Back to top ^}