# README
File Vault Web App
A simple web app to password lock your files.
Table of Contents
About The Project
This is a simple project that allows you to upload a file on the web server and use a password to protect it, later you can download your file if you chose the correct password.
This project was build with the Gin framework and the Go programming languages. This still needs a design rework with support for mobile devices and maybe some code refactoring but as of now the app works.
Built With
This project was built with the following technologies:
Getting Started
Before you run the app you need to have the following:
- MongoDB Server
- .env File
MongoDB Server
You need to have MongoDB installed on your machine, if you don't have it installed you can download the installer at the following link.
This link is for the community version of MongoDB, once you've completed the installation process, it should be already up and running.
.env File
In the root of your project folder you also need to create a .env file which will load the environment variables that are needed for the web app to work.
The app requires the following environment variables:
| Variable | Description |
|---|---|
| PORT | The HTTP server port |
| MONGODB_URI | The URI for connecting to your MongoDB server |
| DB_NAME | The name of the database (inside MongoDB) where you want to store the files |
| FILE_DIR | The name of the directory where the uploaded files will be stored |
Here's an example of the .env file:
PORT=3000
MONGODB_URI= mongodb://127.0.0.1:27017/
DB_NAME=VaultWebApp
FILE_DIR=filedb
Usage
If you've followed the getting started correctly, you'll then be able to run the application by just compiling and running the main.go file.