import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import TOCInline from '@theme/TOCInline';
# Getting Started
## Installation
### Using a package manager
Use your favourite package manager to install:
```bash npm2yarn
npm install --save @builddao/near-social-js
```
### Download via a CDN
Include the minified browser bundle directly in your HTML like so:
```html
...
...
```
## Initialization
To initialize the SDK, simply instantiate the [`Social`](../api-reference/social) class:
```js
const { Social } = require('@builddao/near-social-js');
const social = new Social();
```
```js
var social = new NEARSocialSDK();
```
```typescript
import { Social } from '@builddao/near-social-js';
const social = new Social();
```
:::note
By default, the Social SDK is initialized for the mainnet social contract ([`social.near`](https://nearblocks.io/address/social.near)) and the mainnet RPC provider (https://rpc.mainnet.near.org).
:::
:::note
See [`INewSocialOptions`](../api-reference/types#inewsocialoptions) for more information on what options are supported.
:::
## Initialization with a different contract
You can initialize the SDK with a different social contract account by specifying it in the options:
```js
const { Social } = require('@builddao/near-social-js');
const social = new Social({
contractId: 'mysocialcontract.near',
});
```
```js
var social = new NEARSocialSDK({
contractId: 'mysocialcontract.near',
});
```
```typescript
import { Social } from '@builddao/near-social-js';
const social = new Social({
contractId: 'mysocialcontract.near',
});
```
## Initialization with a different network ID
You can use a specific network by initializing the SDK with a known network ID. See [networks](../api-reference/networks) on the supported networks and the RPC URLs they point to.
```js
const { Social } = require('@builddao/near-social-js');
const social = new Social({
contractId: 'v1.social08.testnet',
network: 'testnet',
});
```
```js
var social = new NEARSocialSDK({
contractId: 'v1.social08.testnet',
network: 'testnet'
});
```
```typescript
import { NetworkIDEnum, Social } from '@builddao/near-social-js';
const social = new Social({
contractId: 'v1.social08.testnet',
network: NetworkIDEnum.Testnet,
});
```
:::caution
If using the network ID, make sure you provide the correct social contract for that network.
:::
:::note
An [`UnknownNetworkError`](../api-reference/errors#unkownnetworkerror) will be thrown if the supplied network ID is not known.
:::
## Initialization with a custom RPC provider
If you want to use your own RPC provider, you can initialize the SDK by specifying it in the options:
```js
const { Social } = require('@builddao/near-social-js');
const social = new Social({
network: {
apiKey: 'some key',
url: 'https://custom-rpc.near.org',
},
});
```
```js
var social = new NEARSocialSDK({
network: {
apiKey: 'some key',
url: 'https://custom-rpc.near.org'
}
});
```
```typescript
import { Social } from '@builddao/near-social-js';
const social = new Social({
network: {
apiKey: 'some key',
url: 'https://custom-rpc.near.org',
},
});
```