A JavaScript SDK for interacting with the social contract (social.near) with helper functions for typical social features.
### Table of contents * [1. Overview](#-1-overview) * [2. Documentation](#-2-documentation) * [3. Development](#-3-development) * [3.1. Requirements](#31-requirements) * [3.2. Setup](#32-setup) * [3.3. Build](#33-build) * [4. Appendix](#-4-appendix) * [4.1. Useful Commands](#41-useful-commands) * [4.2. Social Contract](#42-social-contract) * [5. How To Contribute](#-5-how-to-contribute) * [6. License](#-6-license) ## 🔭 1. Overview TBC... [Back to top ^][table-of-contents] ## 📚 2. Documentation For full documentation, please see [here][documentation]. [Back to top ^][table-of-contents] ## 🛠 3. Development ### 3.1. Requirements * Install [Node v18.20.2+][node] * Install [Yarn v1.22.5+][yarn] [Back to top ^][table-of-contents] ### 3.2. Setup 1. Install the dependencies: ```bash $ yarn install ``` [Back to top ^][table-of-contents] ### 3.3. Build * To build simply run: ```bash $ yarn build ``` The above command will compile the Typescript source code into a `dist/` directory. [Back to top ^][table-of-contents] ## 📑 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 ^][table-of-contents] ### 4.2. Social Contract | Network | Account ID | Link | |---------|-----------------------|------------------------------------------------------------------------------------------------------------------------| | Mainnet | `social.near` | [https://nearblocks.io/address/social.near](https://nearblocks.io/address/social.near) | | Testnet | `v1.social08.testnet` | [https://testnet.nearblocks.io/address/v1.social08.testnet](https://testnet.nearblocks.io/address/v1.social08.testnet) | [Back to top ^][table-of-contents] ## 👏 5. How To Contribute Please read the [**Contributing Guide**][contribute] to learn about the development process. [Back to top ^][table-of-contents] ## 📄 6. License Please refer to the [LICENSE][license] file. [Back to top ^][table-of-contents] [contribute]: ./CONTRIBUTING.md [documentation]: https://nearbuilders.github.io/near-social-js [license]: ./LICENSE [node]: https://nodejs.org/en/ [table-of-contents]: #table-of-contents [yarn]: https://yarnpkg.com/