readme + ci/cd added

Author: dipandhali2021

.env.example

@@ -1,5 +1,6 @@
 VITE_APP_MODULE_NAME=first_contract
 VITE_APP_NETWORK=testnet
-VITE_APP_MODULE_ADDRESS=0x9e0fa0199574b8e233b5e00b2625f55f2490264452d9e
-VITE_APP_PINATA_API_KEY=490fe61c
-VITE_APP_PINATA_SECRET_API_KEY=484cd6f5127e1ef963b691207df29
+VITE_APP_MODULE_ADDRESS=your_smart_contract_address_here
+VITE_APP_PINATA_API_KEY=your_pinata_api_key_here
+VITE_APP_PINATA_SECRET_API_KEY=your_pinata_secret_api_key_here
+VITE_GEMINI_API_KEY=your_gemini_api_key_here

.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI/CD
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: '18'
+        cache: 'npm'
+
+    - name: Install dependencies
+      run: npm ci
+
+    - name: TypeScript check
+      run: npx tsc --noEmit
+
+    - name: Run ESLint
+      run: npm run lint
+
+    - name: Build
+      run: npm run build
+
+  

README.md

@@ -2,30 +2,65 @@
 
 Welcome to Sault, your trusted document management solution that leverages blockchain technology for secure, transparent, and efficient document handling.
 
-
 <img src="./public/logo.png" alt="Sault Logo" width="100" />
 
+---
+
+## 🔍 Problem → Cause → Solution Journey
+
+### 🔴 Problem
+
+- Organizations face **difficulty managing important documents**.
+- Traditional methods are often **scattered, unsecure**, and **lack categorization**.
+- It becomes **time-consuming** to locate, verify, and organize files.
+- There's a **risk of data loss, fraud**, or unauthorized access.
+- Lack of Trust in Bussiness contract
+
+### 🔠 Causes
+
+- Paper or traditional digital systems are **decentralized and disorganized**.
+- **Lack of encryption** and verification mechanisms.
+- **No single secure repository** for all types of documents.
+- Difficulty in **detecting duplicate or tampered files**.
+
+### 🟢 Solution – SAULT
+
+- **Secure Vault**: All your documents are safely stored with blockchain immutability.
+- **Robust Contract**: There is share in which two or more parties can sign a contract and verify while making a legal deals, decision etc. 
+- **AI-powered Categorization**: Easily organize and retrieve files with intelligent tagging.
+- **Fraud Detection**: Detect duplicates, tampered files, and fraudulent documents.
+- **Legal and Transparent**: Every transaction and update is securely logged.
+- **Chatbot Interface**: Easily query and interact with documents.
+- **Blockchain + AI Combo**: Offers security, auditability, and convenience in one place.
+
+---
+
 ## 🌟 Features
 
-- 📑 **Secure Document Storage**: Store your documents with blockchain-backed security
+- 📁 **Secure Document Storage**: Store your documents with blockchain-backed security
 - ✍️ **Document Signing**: Digital signature capabilities for legal documents
-- 🏷️ **Smart Categorization**: Organize documents with intelligent categorization
+- 🏼 **Smart Categorization**: Organize documents with intelligent categorization
 - 📊 **Analytics Dashboard**: Track and analyze document metrics
 - 🔒 **Wallet Integration**: Seamless connection with Aptos blockchain wallets
 - ⚡ **Fast Retrieval**: Quick access to your stored documents
 - 📱 **Responsive Design**: Works perfectly on both desktop and mobile devices
 
+---
+
 ## 🛠️ Technology Stack
 
-- **Frontend**: React 18 with TypeScript
+- **Frontend**  : React 18 with TypeScript
 - **Build Tool**: Vite
-- **Styling**: Tailwind CSS
+- **Styling**   : Tailwind CSS
 - **Components**: Radix UI
 - **Blockchain**: Aptos Network
-- **Charts**: Chart.js & Recharts
-- **Routing**: React Router DOM
+- **Wallet**    : Petra
+- **Charts**    : Chart.js & Recharts
+- **Routing**   : React Router DOM
 - **State Management**: React Context
 
+---
+
 ## 🚀 Getting Started
 
 ### Prerequisites
@@ -36,54 +71,30 @@ Welcome to Sault, your trusted document management solution that leverages block
 
 ### Installation
 
-1. Clone the repository:
 ```bash
-git clone <repository-url>
+git clone https://github.com/ashwinkothavade/HackByte3.0
 cd sault
-```
-
-2. Install dependencies:
-```bash
 npm install
-```
-
-3. Set up environment variables:
-```bash
 cp .env.example .env
-```
-Fill in the required environment variables in the `.env` file.
-
-### Development
-
-Start the development server:
-```bash
+# Fill in required variables
 npm run dev
 ```
-The application will be available at `http://localhost:5173`
 
-### Building for Production
-
-Build the project:
-```bash
-npm run build
-```
+Visit `http://localhost:5173` to start using the app.
 
-Preview the production build:
-```bash
-npm run preview
-```
+---
 
 ## 📦 Project Structure
 
 ```
 sault/
-├── blockchain_0/        # Aptos smart contract code
-├── frontend/
-│   ├── components/      # React components
-│   ├── utils/          # Utility functions
-│   └── lib/            # Shared libraries
-├── public/             # Static assets
-└── scripts/            # Build and deployment scripts
+🔽️── blockchain_0/        # Aptos smart contract code
+🔽️── frontend/
+    🔽️── components/      # React components
+    🔽️── utils/           # Utility functions
+    🔽️── lib/             # Shared libraries
+🔽️── public/              # Static assets
+🔽️── scripts/             # Build and deployment scripts
 ```
 
 ## 💻 Available Scripts
@@ -99,6 +110,20 @@ sault/
 - `npm run move:compile`: Compile Move modules
 - `npm run move:publish`: Publish Move modules
 
+---
+
+## 📊 Workflow
+
+<img src="./public/workflow.jpg" alt="workflow" />
+
+---
+
+## 👥 Contributors
+
+<img src="./public/contri.jpg" alt="contri " width="500" />
+
+---
+
 ## 🤝 Contributing
 
 1. Fork the repository
@@ -107,10 +132,14 @@ sault/
 4. Push to the branch (`git push origin feature/amazing-feature`)
 5. Open a Pull Request
 
+---
+
 ## 📄 License
 
 This project is licensed under the Apache-2.0 License - see the [LICENSE](LICENSE) file for details.
 
+---
+
 ## 🔗 Links
 
 - [Documentation](#)
@@ -119,4 +148,4 @@ This project is licensed under the Apache-2.0 License - see the [LICENSE](LICENS
 
 ---
 
-Made with ❤️ by the Sault Team
+Made with ❤️ by the Sault Team