ABSharing

ABSharing is a secure file-sharing application that allows users to share files with others using expirable links, ensuring privacy and security.

🛠 Project Structure

This is a basic view folder structure. See the docs folder to get a full view.

  - backend (for the backend code)
    - src
    - package.json
    - Dockerfile
  - docs (See here the full folder structure)
  - frontend (all the frontend code)
    - src
    - package.json
    - Dockerfile
  - .gitignore
  - docker-compose.yml
  - README.md

Checkout the docs folder

🌍 Live link

The application is also deployed live at https://absharing-frontend.vercel.app/ where the encrypted files are stored in aws s3.

Note: The backend is deployed on render free version and it goes to sleep if not used. It takes around 30 sec to restart, please wait for it 😅.

🚀 Features

• Signup using mfa: Sign up using mfa and password hashing.

  (mfa disabled for now as SendGrid won't send an email(as I exposed my sengrid API key here), so once you sign in, you can simply sign in without OTP verification or you can get OTP from backend logs to do this step, I have logged it and you can proceed.)

• Secure Files and Share: Your files are encrypted at rest and can be shared with other people.
• Expirable Links: Set expiration times to ensure files are inaccessible after a specific duration.
• Link for specific People: You can also mention emails who can access these files.
• SendGrid Integration: Email notifications with OTPs for added security.
• Fully Dockerized: Easy to set up with Docker Compose.

🛠 Install & Setup

To get started with the project, follow these steps:

1. Prerequisites

Ensure you have the following installed:

• Docker
• Docker Compose

2. Build and Run the Project

Run the following commands from VS code to run the project on your machine:

git clone https://github.com/LanceParker-007/secure-file-share.git

cd secure-file-share

docker-compose up --build

This command will build the frontend and backend services, set up a MongoDB container, and start all services.

Files are encrypted which you check by yourself in the uploads folder

Usage

Once the services are up and running, you can access the application as follows:

• Frontend: Navigate to http://localhost:5173 to use the application.
• Backend: The backend runs at http://localhost:5000.
• MongoDB: MongoDB is accessible at mongodb://localhost:27017/asdatabase.

To Stop the Application

To stop all running services, use:

docker-compose down

🌐 Environment Variables

Ensure the following environment variables are properly set in the respective .env files:

Frontend .env

• VITE_BACKEND_SERVER=http://localhost:5000/api/v1

Backend .env

• PORT=5000 MONGODB_URI=mongodb://mongodb:27017/asdatabase
• FRONTEND_URI=http://localhost:5173
• JWT_SECRET=randomABSharingSecret
• SENDGRID_API_KEY=SG.zFL4D8LyQ4a4L3vvb9RszgHaCBOnXO3kiTuj0XI-8rIYqrJi9yHMXF24jpUhj7LGg
• EMAIL_FROM = microcellops@gmail.com

📚 Project Details

• Frontend: Built with React.js.
• Backend: Built with Node.js and Express.
• Database: MongoDB running as a Docker service.
• Email Service: Integrated with SendGrid in DEV for OTP delivery.

✍️ Author

👤 Harsh Vardhan

• Website: harsh-vardhan.vercel.app
• GitHub: @LanceParker-007

❤️ Show Your Support

If you like this project, give it a ⭐️ to show your support and help it grow!

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

📝 License

This project is licensed under the MIT License. See the LICENSE file for details.

---

Made with ❤️ by Harsh Vardhan.