@builddao/near-social-js
v1.1.0
Published
A JavaScript SDK for interacting with the social contract (social.near) with helper functions for typical social features.
Downloads
223
Maintainers
Readme
Table of contents
🔭 1. Overview
TBC...
📚 2. Documentation
For full documentation, please see here.
🛠 3. Development
3.1. Requirements
- Install Node v18.20.2+
- Install Yarn v1.22.5+
3.2. Setup
- Install the dependencies:
$ yarn install
3.3. Build
- To build simply run:
$ yarn build
The above command will compile the Typescript source code into a dist/
directory.
📑 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. |
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 |
👏 5. How To Contribute
Please read the Contributing Guide to learn about the development process.
📄 6. License
Please refer to the LICENSE file.