Getting Started

This guide will help you install and configure DynamoSearch for your project.

Requirements

• Node.js 20+ installed
• AWS SDK for JavaScript v3 @aws-sdk/client-dynamodb installed
• AWS credentials configured

Installation

Install DynamoSearch using npm, yarn, or pnpm:

npm

npm install dynamosearch

yarn

yarn add dynamosearch

pnpm

pnpm add dynamosearch

For Japanese text analysis, also install the kuromoji plugin:

npm

npm install @dynamosearch/plugin-analysis-kuromoji

yarn

yarn add @dynamosearch/plugin-analysis-kuromoji

pnpm

pnpm add @dynamosearch/plugin-analysis-kuromoji

Next Steps

Choose the appropriate setup guide based on your use case:

• Setting Up for New Tables - Start here if you're creating a new DynamoDB table or don't have existing data to index
• Adding to Existing Tables - Follow this guide if you have an existing table with historical data that needs to be indexed