@banch0u/core-project-test-repository 1.1.0 → 1.2.1

package/README.md

@@ -0,0 +1,91 @@
+# 📦 @banch0u/core-project-test-repository – Development & Deployment Guide
+
+## ✨ Live Development Setup
+
+To develop and test changes in the core package **live** within another project (e.g., `docflow, hr, contract, account and etc.`):
+
+---
+
+### 💠 Step 1: Start the Core Package in Watch Mode
+
+This will watch your `src/` directory for changes, rebuild the `dist/` folder, and automatically push updates to `.yalc`.
+
+```bash
+npm run dev
+```
+
+---
+
+### 💠 Step 2: In Your Main Project (Consumer App)
+
+#### ✅ a. Add the Core Package via Yalc
+
+```bash
+yalc add @banch0u/core-project-test-repository
+```
+
+This will copy the current `dist/` into your project’s `.yalc` folder and update your `package.json`.
+
+#### 🔗 b. Link the Core Package
+
+```bash
+yalc link @banch0u/core-project-test-repository
+```
+
+This creates a symlink to the core package. Now, all changes from the `npm run dev` watcher will reflect in your main app automatically when running the dev server (`npm start`).
+
+---
+
+### ⚠️ Important Notes
+
+- Your `package.json` will temporarily contain this line:
+
+  ```json
+  "@banch0u/core-project-test-repository": "file:.yalc/@banch0u/core-project-test-repository"
+  ```
+
+- **This file path will break production builds or CI/CD pipelines.**
+
+#### ✅ Before Deploying or Committing:
+
+Replace the local Yalc reference with the actual npm package:
+
+```bash
+npm install @banch0u/core-project-test-repository@latest
+```
+
+---
+
+## 📦 Publishing to NPM
+
+### 1. Build the Package
+
+```bash
+npm run build
+```
+
+This will transpile your `src/` folder into the `dist/` folder.
+
+### 2. Bump Version
+
+Use `npm version` to update the package version according to the type of change:
+
+- **Patch** (small fix): `npm version patch` → `1.0.0 → 1.0.1`
+- **Minor** (new feature, backward compatible): `npm version minor` → `1.0.0 → 1.1.0`
+- **Major** (breaking changes): `npm version major` → `1.0.0 → 2.0.0`
+
+### 3. Publish to NPM
+
+```bash
+npm publish
+```
+
+Your changes will now be available on the npm registry. Consumers can install the latest version via:
+
+```bash
+npm install @banch0u/core-project-test-repository@latest
+```
+
+---
+
+Happy coding 💻🚀

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@banch0u/core-project-test-repository",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "Shared core features for all projects",
   "main": "dist/index.js",
   "files": [
@@ -14,15 +14,19 @@
   "author": "banch0u",
   "license": "MIT",
   "scripts": {
-    "build": "babel src --out-dir dist --copy-files"
+    "build": "babel src --out-dir dist --copy-files",
+    "watch": "chokidar \"src\" -i 'dist' -c \"npm run build && yalc push --force\"",
+    "dev": "npm run watch"
   },
   "dependencies": {
     "@microsoft/signalr": "^8.0.7",
     "@pdftron/webviewer": "^11.2.0",
-    "antd": "^5.16.0",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "react-router-dom": "^6.16.0"
+    "antd": "^5.16.0"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0",
+    "react-router-dom": "^6.0.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.26.4",
@@ -30,6 +34,8 @@
     "@babel/plugin-transform-runtime": "^7.26.9",
     "@babel/preset-env": "^7.26.9",
     "@babel/preset-react": "^7.26.3",
-    "babel-loader": "^9.2.1"
+    "babel-loader": "^9.2.1",
+    "chokidar-cli": "^3.0.0",
+    "npm-run-all": "^4.1.5"
   }
 }