README.md

near-social-js

Typescript SDK for interacting with the social contract (social.near)

Table of Contents

• Getting Started
  • Installing dependencies
  • Running the app
  • Building for production
  • Running tests
• Contributing

Getting Started

Installing dependencies

yarn install

Running the app

First, run the development server:

yarn run dev

Building for production

yarn run build

Running tests

yarn run test

See the full testing guide.

Appendix

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

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 fmt	Runs prettier on .js and .ts files.
yarn test	Starts a NEAR development node and runs the tests.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you're interested in contributing to this project, please read the contribution guide.