README.md

secureFile

Desktop Application for Encrypting and Decrypting Text Files with Password Protection to Secure Your Secrets

How to use

1. Start the app
2. Type a password
3. Add your text to the text area: passwords or other secrets you would like to store safely
4. Hit "Save". Your text will be encrypted and saved in files/file.txt encrypted with the password set
5. Close the app

Now you can reopen and read your file using the password you set.

Note: Always remember the password you set before saving. If you change the password, the new password will be required to access the updated version of the file.

Requirements

To run this application, you need to have the following installed on your system:

1. Node.js and npm

   • Download and install Node.js

2. Go

   • go version 1.21+
   • Download and install Go

Getting Started

1. Clone the Repository

git clone https://github.com/loosla/secureFile.git
cd secureFile

2. Install Dependencies for React App

cd frontend
npm install

3. Build and Start the React App

npm run build
npm start

4. Start the Go Backend

Navigate to the backend directory and start the Go server:

cd ../backend
go run .

5. Install Dependencies for Electron

Navigate to electron directory and install Electron:

cd ../electron
npm install

6. Start the Electron App

Navigate to electron directory and start the Electron app:

cd ..
npm start-electron

Quick start with everything pre-installed

npm start

TODO

1. Add config for host, port to share between BE and FE
2. Path to file or file name as an input?