Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinpauljacob committed Jun 22, 2023
1 parent 6dc483e commit 5fd6d44
Showing 1 changed file with 16 additions and 25 deletions.
41 changes: 16 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@

# OneRoof
![App Screenshot](https://cdn.discordapp.com/attachments/918024642860548126/1121323101465100389/mobile_1.png)
# Enigma

Risks of sharing sensitive information like Passwords, Credit Card Information, Private Keys, or other Confidential Data online are increasing daily.
**Risks of sharing sensitive information like Passwords, Credit Card Information, Private Keys, or other Confidential Data online are increasing daily.**

Enigma is a one-time secret message application that allows users to securely share private information with others. The application is built using React.js and Vite, styled using Tailwind CSS, and utilizes Crypto.js for encryption.
**Enigma is a one-time secret message application that allows users to securely share private information with others. The application is built using React.js and Vite, styled using Tailwind CSS, and utilizes Crypto.js for encryption.**

With Enigma, users can create a secret message that can only be accessed once by the intended recipient. The message is encrypted using Crypto.js to ensure that it remains secure until it is opened by the recipient. Once the recipient opens the message, it is immediately deleted from the server, ensuring that the message remains confidential.
**With Enigma, users can create a secret message that can only be accessed once by the intended recipient. The message is encrypted using Crypto.js to ensure that it remains secure until it is opened by the recipient. Once the recipient opens the message, it is immediately deleted from the server, ensuring that the message remains confidential.**

| Encrypt Message | Share Link | Decrypt Message |
| --- | --- | --- |
| ![Image 1](https://cdn.discordapp.com/attachments/918024642860548126/1078350548459335750/mobile_10.png) | ![Image 2](https://cdn.discordapp.com/attachments/918024642860548126/1078350548195086426/mobile_11.png) | ![Image 3](https://cdn.discordapp.com/attachments/918024642860548126/1078350547956015154/mobile_12.png) |

## Deployment

Expand Down Expand Up @@ -41,28 +44,16 @@ With Enigma, users can create a secret message that can only be accessed once by

## Run Locally

Clone the project
```bash
// Clone the Repository
git clone https://github.com/itaintkevin/enigma
```
Go to the project directory
```bash
cd enigma
```
Install dependencies
```bash

// Go to the project directory
cd Enigma

// Install dependencies
yarn
```
Start the server
```bash

// Start the Server
yarn run dev
```


## Screenshots

![App Screenshot](https://cdn.discordapp.com/attachments/918024642860548126/1078350548459335750/mobile_10.png)

![App Screenshot](https://cdn.discordapp.com/attachments/918024642860548126/1078350548195086426/mobile_11.png)

![App Screenshot](https://cdn.discordapp.com/attachments/918024642860548126/1078350547956015154/mobile_12.png)

1 comment on commit 5fd6d44

@vercel
Copy link

@vercel vercel bot commented on 5fd6d44 Jun 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.