From 96a623fe427fa8791209f9643dde29ed82f73f96 Mon Sep 17 00:00:00 2001 From: olusegun0-creator Date: Fri, 15 Aug 2025 12:41:01 +0100 Subject: [PATCH] Add BUILD.md --- BUILD.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 BUILD.md diff --git a/BUILD.md b/BUILD.md new file mode 100644 index 0000000..fad1c30 --- /dev/null +++ b/BUILD.md @@ -0,0 +1,27 @@ +# Build Instructions + +This document provides the instructions to build the project from source. + +## Prerequisites + +- Node.js (v16 or higher) +- yarn + +## Building the project + +1. **Install dependencies:** + + ```bash + yarn install + ``` + +2. **Run the build script:** + The following command will compile the TypeScript code from the `lib` directory and output the result in the `dist` directory. + ```bash + yarn tsc --target es5 --lib es2021,DOM --moduleResolution node --strict --esModuleInterop --declaration --jsx react --skipLibCheck --outDir dist --rootDir lib lib/*.ts lib/**/*.ts lib/**/*.tsx && cp package.json README.md dist/ && find lib/ -type f -name '*.css' -exec sh -c 'cp {} $(echo {} | sed s/^lib/dist/)' \\; + ``` + This command does the following: + +- Compiles TypeScript files to JavaScript. +- Copies `package.json` and `README.md` to the `dist` folder. +- Copies any `.css` files to the `dist` folder, preserving the directory structure.