BUILD_INSTRUCTIONS.md

Building Peek.js

Before getting started with Peek.js, please read through the following instructions:

Step 1: Install Packages:

Install the packages using the following NPM commands:

1. Install TypeScript:

npm install -g typescript

2. Install tsup:

npm i tsup -D

3. Install terser:

npm install terser -D

4. Install swc/core (if ES5 is required):

npm install @swc/core -D

Step 2: Build Project:

1. Full Build:

To build the TypeScript, run the following command:

npm run build-typescript

To build the SASS, run the following command:

npm run build-sass

To build the everything, run the following command:

npm run build

2. Minimized Build:

To build the TypeScript, run the following command:

npm run build-minimized-typescript

To build the SASS, run the following command:

npm run build-minimized-sass

To build the everything, run the following command:

npm run build-minimized

3. ESM Build:

To build the TypeScript, run the following command:

npm run build-typescript-esm