Skip to content

Arshad-ashuu/docvault

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

21 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Portfolio

DocVault πŸ“‚

Secure document and card storage application with family sharing capabilities.

Download πŸ“₯Link

Table of Contents

About

DocVault is a React Native mobile application designed for secure storage and management of important documents and cards. The app enables family members to share and control access to sensitive information through a clean, intuitive interface.

Features

  • πŸ” Secure document and card storage
  • πŸ‘¨β€πŸ‘©β€πŸ‘§β€πŸ‘¦ Family member management and invitations
  • πŸ”„ Document sharing with granular access control
  • πŸ“± Clean and responsive UI
  • πŸ–ΌοΈ Image capture and upload functionality
  • πŸ’Ύ Persistent local and cloud storage
  • πŸ”‘ Authentication system with password recovery


Tech Stack

Frontend

  • React Native - Mobile framework
  • Expo - Development platform
  • React Navigation - Navigation library
  • TypeScript/JavaScript - Programming languages

Backend & Services

  • Supabase - Backend as a Service
    • Authentication
    • Database (PostgreSQL)
    • Storage
    • Real-time subscriptions

Build & Deployment

  • EAS (Expo Application Services) - Build and deployment
  • Expo Go - Development testing

Project Structure

DOCVAULT/
β”œβ”€β”€ app/
β”‚   β”œβ”€β”€ (auth)/                 # Authentication screens
β”‚   β”‚   β”œβ”€β”€ _layout.jsx
β”‚   β”‚   β”œβ”€β”€ forgot-password.jsx
β”‚   β”‚   β”œβ”€β”€ signin.jsx
β”‚   β”‚   └── signup.jsx
β”‚   └── (tabs)/                 # Main app tabs
β”‚       β”œβ”€β”€ _layout.jsx
β”‚       β”œβ”€β”€ family.jsx
β”‚       β”œβ”€β”€ index.jsx
β”‚       └── settings.jsx
β”œβ”€β”€ assets/                     # Static assets
β”‚   β”œβ”€β”€ adaptive-icon.png
β”‚   β”œβ”€β”€ favicon.png
β”‚   β”œβ”€β”€ icon.png
β”‚   └── splash-icon.png
β”œβ”€β”€ config/                     # Configuration files
β”‚   └── supabase.js
β”œβ”€β”€ hooks/                      # Custom React hooks
β”‚   └── useAuth.js
β”œβ”€β”€ services/                   # API and service layers
β”‚   β”œβ”€β”€ storageService.js
β”‚   └── supabaseService.js
β”œβ”€β”€ utils/                      # Utility functions
β”‚   └── downloadImage.js
β”œβ”€β”€ card.jsx                    # Card components
β”œβ”€β”€ cardDetail.jsx
β”œβ”€β”€ familyCards.jsx
β”œβ”€β”€ index.jsx
β”œβ”€β”€ .gitignore
β”œβ”€β”€ app.json                    # Expo configuration
β”œβ”€β”€ package.json
└── README.md

Installation

Prerequisites

  • Node.js >= 16.x
  • npm or yarn
  • Expo CLI
  • Android Studio (for Android) or Xcode (for iOS)

Steps

  1. Clone the repository
git clone https://github.com/yourusername/docvault.git
cd docvault
  1. Install dependencies
npm install
  1. Set up environment variables (see Environment Variables)

  2. Start the development server

npx expo start

Configuration

Supabase Setup

  1. Create a project on Supabase
  2. Set up authentication providers
  3. Create necessary tables and storage buckets
  4. Update config/supabase.js with your credentials

Build

Development Build

npx expo start

Production Build (EAS)

# Android
eas build --platform android --profile production

# iOS
eas build --platform ios --profile production

Generate APK

eas build -p android --profile preview

Environment Variables

Create a .env file in the root directory:

SUPABASE_URL=your_supabase_url
SUPABASE_ANON_KEY=your_supabase_anon_key

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.


Version: 1.0.0
Status: Production Ready

About

Stop losing important documents in your camera roll. docvault keeps everything organized and ready when you need it most. πŸ”₯

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors