Skip to content

Latest commit

 

History

History
166 lines (115 loc) · 4.47 KB

README.md

File metadata and controls

166 lines (115 loc) · 4.47 KB
Raw

FileVault

FileVault is a modern file uploading application with versions for both AWS S3 and Azure Blob Storage. It features a clean interface with light/dark mode toggle and file management capabilities.

Application Screenshots

FileVault Interface

FileVault

Upload File to Azure Storage Account

Upload File to Azure Storage Account

The upload screen allows you to select a file and enter a name for the file. Upon clicking the submit button, the file is uploaded to the Azure Blob Storage.

File Appears in Azure Storage Account

File Appears in Azure SA

This screen shows the file successfully uploaded to the Azure Blob Storage container. The table displays the file name and its corresponding key.

Delete File

Delete File

This screen demonstrates the delete functionality. Clicking the delete button removes the file from the cloud storage and updates the table accordingly.

File Removed from Azure Storage Account

File Removed from Azure SA

This screen shows that the file has been successfully deleted from the Azure Blob Storage container, and the table has been updated to reflect this.

Toggle Light/Dark Mode

Toggle Light/Dark Mode

This screen shows the light mode when you slide the toggle switch.

Features

  • Upload files to cloud storage (AWS S3 or Azure Blob Storage).
  • Save and retrieve file metadata.
  • Delete files directly from the table.
  • Light/Dark mode toggle.

Prerequisites

  • Node.js
  • AWS or Azure account with appropriate storage setup
  • AWS S3 bucket or Azure Storage Account and Container
  • Appropriate credentials for AWS or Azure

Getting Started

Clone the Repository

git clone https://github.com/yourusername/filevault.git
cd filevault

Project Structure

filevault/
├── src/
│   ├── aws-s3/
│   │   ├── public/
│   │   │   ├── app.js
│   │   │   ├── index.html
│   │   │   └── styles.css
│   │   ├── uploads/
│   │   ├── filesData.json
│   │   ├── .env.example
│   │   ├── index.js
│   │   ├── package.json
│   │   └── package-lock.json
│   ├── azure-blob/
│   │   ├── public/
│   │   │   ├── app.js
│   │   │   ├── index.html
│   │   │   └── styles.css
│   │   ├── uploads/
│   │   ├── filesData.json
│   │   ├── .env.example
│   │   ├── index.js
│   │   ├── package.json
│   │   └── package-lock.json
├── images/
│   ├── filevault.png
│   ├── upload-file-to-azure-storage-account.png
│   ├── file-appears-in-azure-sa.png
│   ├── delete-file.png
│   ├── file-removed-from-azure-sa.png
|   ├── toggle.png
├── .gitignore
└── README.md

Setup for AWS S3

Configuration

Navigate to the src/aws-s3 directory and create a .env file based on the .env.example:

AWS_ACCESS_KEY_ID=your-access-key-id
AWS_SECRET_ACCESS_KEY=your-secret-access-key
AWS_REGION=your-region
S3_BUCKET_NAME=your-s3-bucket-name
PORT=3000

Install Dependencies

cd src/aws-s3
npm install express multer dotenv @aws-sdk/client-s3 @aws-sdk/lib-storage

Setup on Azure Storage Accounts

Configuration

Navigate to the src/azure-blob directory and create a .env file based on the .env.example:

AZURE_STORAGE_ACCOUNT_NAME=your-storage-account-name
AZURE_STORAGE_ACCOUNT_KEY=your-storage-account-key
AZURE_CONTAINER_NAME=your-container-name
PORT=3000

Install Dependencies

cd src/azure-blob
npm install express multer dotenv @azure/storage-blob

Running and Accessing the Application

node index.js

Open your browser and navigate to http://localhost:3000.

Technologies Used

  • Node.js
  • AWS S3 or Azure Storage Accounts
  • HTML, CSS, JavaScript

To-Do

  • Use a Database for Persistent Data: Replace the filesData.json with a database (e.g., MongoDB, PostgreSQL) to store file metadata persistently.

  • User Authentication: Implement user authentication to manage user-specific files securely.

  • File Search and Filtering: Add functionality to search and filter files in the table.

  • Drag and Drop Upload: Enhance the upload feature with drag and drop functionality.