Skip to content

Latest commit

 

History

History
100 lines (75 loc) · 2.31 KB

README.md

File metadata and controls

100 lines (75 loc) · 2.31 KB

SecurMask-Lite

SecurMask-Lite is a lite version of a web application designed for masking sensitive data in CSV and XLSX files. This tool is built to help organizations and individuals protect sensitive information.

Features

  • Data Masking: Encrypt sensitive data in specified columns of CSV or XLSX files.
  • User-Friendly Interface: Simple and intuitive web-based interface.
  • Secure Encryption: Utilizes the cryptography library for robust data encryption.

Tech Stack

  • Frontend: React.js
  • Backend: Python (Flask)
  • Libraries:
    • Frontend: Material-UI for UI components, Axios for API requests
    • Backend: Flask for server-side operations, Cryptography for encryption, Pandas for file processing

Installation and Setup

Prerequisites

  • Python 3.8 or later
  • Node.js 14.x or later
  • npm or yarn

Backend Setup

  1. Clone the repository and navigate to the backend folder:

    git clone https://github.com/ird1natris/SecurMask-Lite.git
cd SecurMask-Lite/backend

  2. Create and activate a virtual environment (optional):

    python -m venv venv
source venv/bin/activate  # macOS/Linux
venv\Scripts\activate   # Windows

  3. Install dependencies:

    pip install -r requirements.txt

  4. Start the Flask server:

    python app.py

The backend server will run at http://127.0.0.1:5000.

Frontend Setup

  1. Navigate to the frontend folder:

    cd ../frontend

  2. Install dependencies:

    npm install

  3. Start the React development server:

    npm start

The frontend app will run at http://localhost:3000.

Usage

  1. Open the frontend in your browser at http://localhost:3000.
  2. Upload a CSV or XLSX file.
  3. Specify the columns to mask or unmask.
  4. Choose the action (mask or unmask) and submit the file.
  5. Download the processed file with the changes applied.

Contributing

  1. Clone the repository:
git clone https://github.com/ird1natris/SecurMask-Lite.git  
cd SecurMask-Lite
  1. Work on the project, making changes locally.
  2. Push changes to the repository:
git add .  
git commit -m "[TYPE] Your commit message"  
git push origin main
  1. Ensure to pull any updates before working further:
git pull origin main