From 33904eaf9513d4bd7e839c5681de5c3f2dd41cde Mon Sep 17 00:00:00 2001 From: LottR079 Date: Tue, 2 Dec 2025 12:55:30 +0100 Subject: [PATCH] docs: add getting started guide for examples MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit a separate file docs/getting-started-with-examples.md appeared with a step-by-step “getting started” guide: how to install dependencies, configure .env based on .env.example and run TypeScript examples via ts-node without any guesswork. --- docs/getting-started-with-examples.md | 45 +++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 docs/getting-started-with-examples.md diff --git a/docs/getting-started-with-examples.md b/docs/getting-started-with-examples.md new file mode 100644 index 0000000..215e6cd --- /dev/null +++ b/docs/getting-started-with-examples.md @@ -0,0 +1,45 @@ +# Getting started with the Polymarket examples + +This document explains how to set up and run the examples in this repository using a local Node.js environment. + +It is intended for developers who are new to the Polymarket API and want a simple, copy-pasteable workflow for trying out the examples. + +--- + +## 1. What this repository contains + +This repository provides TypeScript examples that demonstrate how to: + +- interact with Polymarket smart contract wallets +- work with proxy wallets (email / Magic accounts) +- work with safe wallets (browser wallets like MetaMask or Rainbow) + +The examples are organized under the `examples/` directory. +You can run them directly with `ts-node` once your environment is configured. + +For a high-level overview of Polymarket developer tooling (CLOB clients, order utils, Gamma API, etc.), refer to the official documentation website. + +--- + +## 2. Prerequisites + +Before running any examples, you will need: + +- **Node.js** (recommended: LTS or newer) +- **Yarn** or **npm** for installing dependencies +- A **Polymarket account** with access to the relevant network +- Any required API keys or private keys, depending on the example you run + +> Never commit secrets (private keys, API keys, etc.) to Git. +> Always keep them in local `.env` files or secret managers. + +--- + +## 3. Installing dependencies + +From the repository root: + +1. Install dependencies: + + ```bash + yarn install