@arun-syngrid/hippaguard 0.1.0

package/README.md

@@ -0,0 +1,206 @@
+# HIPPAGuard 🔒
+
+Secure form handling with client-side encryption for React applications - HIPAA-compliant form components with built-in security.
+
+<p align="center">
+  <img src="assets/logo.svg" width="64" height="64" alt="HIPPAGuard Logo" />
+</p>
+
+[![npm version](https://badge.fury.io/js/@hippaguard%2Freact.svg)](https://badge.fury.io/js/@hippaguard%2Freact)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Test Coverage](https://img.shields.io/badge/coverage-87%25-green.svg)](https://github.com/Anas-debug/HIPPAGuard)
+
+## Overview
+
+HIPPAGuard provides secure form components for handling sensitive healthcare data in React applications. It includes built-in encryption, data protection, and HIPAA compliance features.
+
+## Key Features
+
+- 🔒 Client-side AES-256-GCM encryption
+- ⚕️ HIPAA & PHI/PII data protection 
+- 🛡️ Form validation & sanitization
+- 🔄 Simple React hooks API
+- 📝 Full TypeScript support
+- ✅ Extensive test coverage
+- 🚀 Lightweight with minimal dependencies
+- 💪 Built for production use
+
+## Getting Started
+
+### Installation
+
+```sh
+npm install @hippaguard/react
+```
+
+### Basic Usage
+
+```tsx
+import { SecureForm, SecureField } from '@hippaguard/react';
+
+function PatientForm() {
+  const handleSubmit = async (data) => {
+    // Data is automatically encrypted
+    console.log('Encrypted form data:', data);
+  };
+
+  return (
+    <SecureForm onSubmit={handleSubmit}>
+      <SecureField
+        name="firstName" 
+        label="First Name"
+        required
+        sensitivityLevel="PHI"
+      />
+      
+      <SecureTextArea
+        name="symptoms"
+        label="Current Symptoms" 
+        sensitivityLevel="PHI"
+      />
+
+      <button type="submit">
+        Submit
+      </button>
+    </SecureForm>
+  );
+}
+```
+
+## Core Components
+
+### SecureField
+Standard input field with encryption and validation.
+
+```tsx
+<SecureField
+  name="ssn"
+  label="Social Security Number" 
+  type="text"
+  sensitivityLevel="PII"
+  validateFn={validateSSN}
+  required
+/>
+```
+
+### SecureTextArea
+Multiline text input with encryption.
+
+```tsx
+<SecureTextArea
+  name="notes"
+  label="Medical Notes"
+  rows={4}
+  sensitivityLevel="PHI" 
+/>
+```
+
+### SecureCheckbox
+Secure checkbox component.
+
+```tsx
+<SecureCheckbox
+  name="consent"
+  label="I consent to treatment"
+  sensitivityLevel="PHI"
+/>
+```
+
+### SecureRadioGroup
+Radio button group with encryption.
+
+```tsx
+<SecureRadioGroup
+  name="gender"
+  label="Gender"
+  options={['Male', 'Female', 'Other']}
+  sensitivityLevel="PHI"
+/>
+```
+
+## Validation
+
+Built-in validation helpers:
+
+```tsx
+import { validators } from '@hippaguard/react';
+
+<SecureField
+  name="email"
+  validateFn={validators.combine([
+    validators.required(),
+    validators.email()
+  ])}
+/>
+```
+
+## Context & Hooks
+
+### SecurityProvider
+Provides encryption context.
+
+```tsx
+import { SecurityProvider } from '@hippaguard/react';
+
+function App() {
+  return (
+    <SecurityProvider>
+      <YourApp />
+    </SecurityProvider>
+  );
+}
+```
+
+### useSecurity
+Access encryption functions.
+
+```tsx
+const { encrypt, decrypt } = useSecurity();
+```
+
+## Security Features
+
+- 🔐 AES-256-GCM encryption
+- 🔑 Unique IV per encryption
+- 🛡️ PBKDF2 key derivation
+- 🧹 Auto key cleanup
+- 🔒 Zero plaintext storage
+- ✅ Input sanitization 
+
+## Contributing
+
+We welcome contributions! Please check our [Contributing Guide](CONTRIBUTING.md).
+
+### Development
+
+1. Clone repo
+```sh
+git clone https://github.com/Anas-debug/HIPPAGuard.git
+```
+
+2. Install dependencies
+```sh
+npm install
+```
+
+3. Run tests
+```sh
+npm test
+```
+
+### Testing
+- Unit tests
+- Integration tests  
+- Security tests
+- Edge cases
+- Current coverage: ~87%
+
+## Support
+
+- 📝 [Documentation](https://github.com/Anas-debug/HIPPAGuard)
+- 🐛 [Issues](https://github.com/Anas-debug/HIPPAGuard/issues)
+- ✉️ [Email](mailto:security@hippaguard.dev)
+
+## License
+
+[MIT](LICENSE) © [Anas Saoui](https://github.com/Anas-debug)