Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions Build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Build Instructions

This document provides instructions on how to build the `ion-sdk-js` project from source.

## Prerequisites

Before you begin, ensure you have the following installed:
- [Node.js](httpss://nodejs.org/) (which includes npm)
- [Yarn](httpss://yarnpkg.com/) (optional, but recommended)

## Steps

1. **Clone the repository:**
```sh
git clone https://github.com/pion/ion-sdk-js.git
cd ion-sdk-js
```

2. **Install dependencies:**

You can use either npm or yarn to install the project dependencies.

Using npm:
```sh
npm install
```

Using yarn:
```sh
yarn install
```

3. **Build the project:**

The project can be built by running the following command, which will compile the TypeScript code and then bundle it using webpack.

Using npm:
```sh
npm run prepare
```

Using yarn:
```sh
yarn prepare
```

This will generate the compiled and bundled files in the `lib` and `dist` directories, respectively.