added docs and workflows

Author: Harshdev098

.github/workflows/lint.yml

@@ -0,0 +1,28 @@
+name: Lint
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  eslint:
+    name: Run ESLint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run ESLint
+        run: npm run lint

.github/workflows/type.yml

@@ -0,0 +1,19 @@
+name: Type Check
+
+on:
+  pull_request:
+  push:
+    branches:
+        - main
+
+jobs:
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+      - run: npm ci
+      - run: npm run type-check

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "singleQuote": true,
+  "semi": true,
+  "trailingComma": "es5",
+  "printWidth": 100,
+  "tabWidth": 4
+}

CONTRIBUTION.md

@@ -0,0 +1,70 @@
+Welcome to Fediming Web Wallet, a fedimint project which is build to make fedimint accesible via web to the users to custody their bitcoins and transact with them, before contributing to the project 
+please go through our contribution guidelines and be adhere to the points. If you have any doubts about guidelines or contributing to the project, please open an issue regarding that, we will help for the same.
+
+## Technical Note
+
+This wallet is built using the **[Fedimint Web SDK](https://github.com/fedimint/fedimint-web-sdk)**, which:
+
+- Loads *WebAssembly (WASM)* modules compiled from Fedimint’s Rust code.
+- Uses *Web Workers* to execute WASM tasks in the background without blocking the UI.
+- Provides RPC calls to interact with the federation, handle e-cash, Lightning payments, and on-chain transactions directly in the browser.
+
+If you want to understand or extend the wallet's core logic, you can explore:
+- *Fedimint Web SDK*: Learn how the WASM module is initialized and how the SDK functions are used in the wallet.
+- *Fedimint Rust repository*: Understand the backend implementation that powers the federation logic and RPC endpoints.
+
+📚 Helpful links:
+- [Fedimint Main Repository](https://github.com/fedimint/fedimint)
+- [Fedimint Web SDK Repository](https://github.com/fedimint/fedimint-web-sdk)
+
+Understanding these will help to contribute more effectively, especially when working on features that interact with the federation directly.
+
+## Contributing
+
+- Any low code, UI enhancement, implementing new feature, solving an issue, opening an issue is appreciable
+- Before making any changes make sure that your fork is synced and your clone is upto date with the main branch
+- You can open issues in issue section regarding a doubt,reporting a bug, setting up the project
+- Be polite and interactive with other developers.Don't be offensive.
+- Test your code before submitting the PR.
+
+## Opening a Pull Request
+
+- Fork the repository to your account.
+- Clone the repository locally
+  
+  git clone https://github.com/Harshdev098/fedimint-web-wallet.git
+  
+- Make sure to work on a different branch if wanted to open multiple PRs.
+- Have a run in local and explore the working of wallet
+- Make your desired changes for the contribution
+- Test the changes and ensure it should not break the functionality
+- Check lint and type check before pushing!
+
+  ```
+  npm run lint && npm run type-check
+  ```
+
+  to fix the linting
+
+  ```
+  npm run lint:fix
+  ```
+
+- Commit your changes with an appropriate commit prefix:
+  - **fix:** A bug fix, workflow change, or similar.
+  - **feat:** A new feature or enhancement.
+  - **docs:** Documentation updates, fixes, or typo corrections.
+  - **chore:** Miscellaneous changes that don’t fit into the above categories.
+- Push your changes and open a PR on this repo.
+
+## Creating Issues
+
+When opening an issue, please follow these guidelines to help us understand and resolve it quickly:
+
+- **Use a clear and descriptive title** that accurately summarizes the issue.
+- **Provide references** (links, file paths, or relevant code snippets) to help locate the problem.
+- **Include screenshots or videos** if the issue is UI-related, so we can visualize it easily.
+- When **requesting a new feature**, clearly describe:
+  - What the feature should do.
+  - Where and how you expect it to be integrated into the wallet.
+  - Any related examples or references (if available).

README.md

@@ -1,5 +1,108 @@
-# Fedimint Web Wallet
-A web wallet using Chaumian Ecash while giving previlige to custody and transact Bitcoin.
+# 🌐 Fedimint Web Wallet
 
-## Running the application
-Within the root folder of the repository run: `npm run dev`
+Are you a *privacy-conscious* person who wants to *custody Bitcoin* in a *decentralized* way?  
+*Fedimint Web Wallet* is a browser-based Bitcoin wallet built on the [Fedimint Web SDK](https://github.com/fedimint/fedimint-web-sdk).  
+It enables you to *custody* and *transact Bitcoin* using *Chaumian Ecash* in a *federated, **privacy-preserving* way — all *without installing extra software*.
+
+> 🔐 Custody Bitcoin with ease and privacy — you control your funds, your community, your future.
+
+---
+
+## 🏛 About Fedimint
+
+[Fedimint](https://github.com/fedimint/fedimint) is a *modular system* for building federated applications, designed to be:
+
+- *🛡 Trust-minimized* – You control your funds with federation consensus.  
+- *🚫 Censorship-resistant* – No single point of control.  
+- *👤 Private* – Transactions can’t be linked back to you.
+
+---
+
+## ✨ Features
+
+- 🔍 *Discover & Join Federations*  
+  Join a federation using an invite code/QR or discover available federations instantly.
+  
+- 👁 *Preview Before Joining*  
+  View full federation details, guardian info, and federation health.
+  
+- 💸 *Multiple Payment Methods*  
+  - Lightning Network  
+  - On-chain Bitcoin transactions  
+  - Ecash transactions
+
+- 📊 *Comprehensive Federation Insights*  
+  See guardian availability, federation health, and service status.
+  
+- 🌐 *Multi-Federation Support*  
+  Join and manage multiple federations at once.
+  
+- 📜 *Transaction Management*  
+  View full transaction history, manage invoices (paid & pending), and export transactions.
+  
+- ♻ *Backup & Recovery*  
+  Securely backup and restore your wallet.
+  
+- 🔗 *NIP-47 Integration* (Nostr Wallet Connect)  
+  Connect your client to the wallet via NWC URI to send and receive payments.
+  
+- ⚙ Other useful features:
+  - Auto nostr payments, auto withdrawal to an external address
+  - Enabling GeoLocation, themes, developer mode according to preferences
+  - Change the display currency, export transactions, setting a invoice desription
+
+## 🛠 Technical Stack
+
+- ⚡ The project uses Vite + React + Typescript.
+- 🏦 [Fedimint-web-sdk](https://github.com/fedimint/fedimint-web-sdk) is used for interacting with the fedimint.
+- 🔌 [NDK](https://github.com/nostr-dev-kit/ndk) for NWC integeration
+- 📦 Redux is used as the primary state management library and Context API is mainly used for Fedimint sdk and NDK management.
+
+## Structure
+
+```plaintext
+fedimint-web-wallet/
+├── src
+│   ├── assets/
+│   ├── Components/
+│   ├── context/
+│   ├── hooks/
+│   ├── pages/
+│   ├── redux/
+│   ├── services/
+│   ├── style/
+│   ├── utils/
+│   ├── App.tsx
+│   ├── Wallet.tsx
+ ```
+
+- **Appp.tsx:** Root application component
+- **Wallet.tsx:** Core wallet UI logic
+- **Components:** The component folder contains all of the UI components(Activities,AddFederation,Header...)
+- **Pages:** The Pages folder contains all the of the pages and tabs of the main wallet(JoinFederation,Ecash,Settings...)
+- **Redux:** Redux files manages the fedimint web sdk and NDK initialization and thier working
+  - WalletManger manages the switching of the federations, loading wallet data, initializing of the wallet and giving wallet instance to their childrens and with some other functionalities
+  - Nostr context runs in the background without blocking the wallet functionalities or UI renderings like intializing NDK, connecting to relays, setting up subscriptions for the following nostr events(get_info, pay_invoice, make_invoice, get_balance, list_transactions, lookup_invoice, notifications, payment_sent, payment_received)
+- **Services:** The services folder contains the helper functions and the main fedimint web sdk rpc methods. 
+
+## 🚀 Running the application
+
+- Clone the repository
+  
+  git clone https://github.com/Harshdev098/fedimint-web-wallet.git
+  
+- Install the dependencies
+  
+  ```
+    npm install
+  ```
+  
+- Start the app in development mode
+  
+  ```
+    npm run dev
+  ```
+
+## 🤝 Contributions
+
+ Before contributing to the project please go through our contribution guidelines [Contribution.md](CONTRIBUTION.md)

eslint.config.js

@@ -1,13 +1,19 @@
-import js from '@eslint/js'
-import globals from 'globals'
-import reactHooks from 'eslint-plugin-react-hooks'
-import reactRefresh from 'eslint-plugin-react-refresh'
-import tseslint from 'typescript-eslint'
+import js from '@eslint/js';
+import globals from 'globals';
+import reactHooks from 'eslint-plugin-react-hooks';
+import reactRefresh from 'eslint-plugin-react-refresh';
+import tseslint from 'typescript-eslint';
+import prettier from 'eslint-plugin-prettier';
+import eslintConfigPrettier from 'eslint-config-prettier';
 
 export default tseslint.config(
   { ignores: ['dist'] },
   {
-    extends: [js.configs.recommended, ...tseslint.configs.recommended],
+    extends: [
+      js.configs.recommended,
+      ...tseslint.configs.recommended,
+      eslintConfigPrettier
+    ],
     files: ['**/*.{ts,tsx}'],
     languageOptions: {
       ecmaVersion: 2020,
@@ -16,13 +22,16 @@ export default tseslint.config(
     plugins: {
       'react-hooks': reactHooks,
       'react-refresh': reactRefresh,
+      prettier
     },
     rules: {
       ...reactHooks.configs.recommended.rules,
       'react-refresh/only-export-components': [
         'warn',
         { allowConstantExport: true },
       ],
+      'prettier/prettier': 'error',
+      '@typescript-eslint/no-explicit-any': 'warn'
     },
   },
-)
+);