Skip to content

Latest commit

 

History

History
87 lines (67 loc) · 2.64 KB

README.md

File metadata and controls

87 lines (67 loc) · 2.64 KB
Raw

My Encryption App

TypeScript Node.js Express Mongoose Frontend

Overview

My Encryption App is a web application designed to provide users with a secure and user-friendly way to encrypt and decrypt messages. Users can select an encryption algorithm, enter a message, and receive an encrypted string. The app also offers the ability to generate a QR code containing the encrypted data and the algorithm used, which can be decrypted by scanning through the website.

Features

  • User Authentication: Secure login and registration with JWT-based authentication.
  • Message Encryption: Choose from various algorithms to encrypt messages.
  • QR Code Generation: Generate a QR code with encrypted data and algorithm details.
  • Message Decryption: Decrypt messages using the selected algorithm or by scanning the QR code.
  • File Encryption (Upcoming in v1.1): Encrypt and decrypt files securely.

Getting Started

Backend

The backend of this application is built using Node.js, Express, and Mongoose, and is written in TypeScript. It handles user authentication, encryption/decryption logic, and database interactions.

How to Run the Backend

  1. Navigate to the Backend Directory: 
    cd backend
  2. Compile TypeScript: 
    tsc -b
  3. Run the Server: 
    cd dist
node server.js

For detailed technical documentation on the backend, visit the Backend Documentation.

Frontend

The frontend is built with Vue.js and is responsible for the user interface, including the input forms, displaying encrypted messages, and scanning QR codes.

How to Run the Frontend

  1. Navigate to the Frontend Directory: 
    cd frontend
  2. Start the Development Server: 
    npm run dev

For detailed technical documentation on the frontend, visit the Frontend Documentation.

Project Structure

my-encryption-app/
│
├── backend/
│   ├── dist/
│   ├── src/
│   ├── package.json
│   ├── tsconfig.json
│   └── README.md
│
├── frontend/
│   ├── src/
│   ├── public/
│   ├── package.json
│   ├── tsconfig.json
│   └── README.md
│
├── .gitignore
└── README.md (this file)

License

This project is licensed under the MIT License.