finance-shared 0.0.1

package/README.md

@@ -0,0 +1,104 @@
+# React + TypeScript + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+
+## How to Update and Use This Library in Another Project
+
+### When Making Changes to This Library:
+
+1. **Make your changes** to the library code
+
+2. **Build the library**
+   ```bash
+   npm run build
+   ```
+
+3. **Update version in package.json**
+   ```bash
+   # Edit package.json and increment version (e.g., from 0.0.44 to 0.0.45)
+   ```
+
+4. **Pack the library**
+   ```bash
+   npm pack
+   ```
+   This creates a `.tgz` file like `finance-shared-library-v0.0.45.tgz`
+
+5. **Copy the full path** of the generated `.tgz` file
+
+### In Your Main Project:
+
+1. **Remove the old version**
+   ```bash
+   npm uninstall finance-shared-library
+   ```
+
+2. **Install the new version using the copied path**
+   ```bash
+   npm install /full/path/to/finance-shared-library-v0.0.45.tgz
+   ```
+
+### Example Complete Workflow:
+
+```bash
+# In library project
+npm run build
+# Edit package.json: change version from "0.0.44" to "0.0.45"
+npm pack
+# Copy path: /Users/username/finance-library/common-library/finance-shared-library-v0.0.45.tgz
+
+# In main project
+npm uninstall finance-shared-library
+npm install /Users/username/finance-library/common-library/finance-shared-library-v0.0.45.tgz
+```
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+
+```js
+export default tseslint.config({
+  extends: [
+    // Remove ...tseslint.configs.recommended and replace with this
+    ...tseslint.configs.recommendedTypeChecked,
+    // Alternatively, use this for stricter rules
+    ...tseslint.configs.strictTypeChecked,
+    // Optionally, add this for stylistic rules
+    ...tseslint.configs.stylisticTypeChecked,
+  ],
+  languageOptions: {
+    // other options...
+    parserOptions: {
+      project: ['./tsconfig.node.json', './tsconfig.app.json'],
+      tsconfigRootDir: import.meta.dirname,
+    },
+  },
+})
+```
+
+You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+
+```js
+// eslint.config.js
+import reactX from 'eslint-plugin-react-x'
+import reactDom from 'eslint-plugin-react-dom'
+
+export default tseslint.config({
+  plugins: {
+    // Add the react-x and react-dom plugins
+    'react-x': reactX,
+    'react-dom': reactDom,
+  },
+  rules: {
+    // other rules...
+    // Enable its recommended typescript rules
+    ...reactX.configs['recommended-typescript'].rules,
+    ...reactDom.configs.recommended.rules,
+  },
+})
+```