Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aifia105/file-sharing-platform-backend
This project focuses on securely sharing files between users, with added features like setting expiration dates for files and sending notifications when files are about to expire or have been downloaded
https://github.com/aifia105/file-sharing-platform-backend
file-sharing javascript mongodb mongoose nestjs typescript
Last synced: 26 days ago
JSON representation
This project focuses on securely sharing files between users, with added features like setting expiration dates for files and sending notifications when files are about to expire or have been downloaded
- Host: GitHub
- URL: https://github.com/aifia105/file-sharing-platform-backend
- Owner: aifia105
- Created: 2024-10-31T09:54:24.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-21T19:24:48.000Z (about 2 months ago)
- Last Synced: 2024-11-21T19:28:01.095Z (about 2 months ago)
- Topics: file-sharing, javascript, mongodb, mongoose, nestjs, typescript
- Language: TypeScript
- Homepage:
- Size: 262 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# File Sharing Platform Backend
This is the backend server for a File Sharing Platform, providing secure file upload, sharing, and access management. This server handles API requests for file uploads, metadata storage, access control, logging, and file downloads. The backend is built with Nest.js and uses MongoDB to store metadata, with file storage.
## Features
- **User Authentication**: Secure signup, login, and JWT-based authorization.
- **File Upload & Management**: Handles file uploads and stores file metadata.
- **Access Control**: Allows users to set file access permissions and expiration dates for secure sharing.
- **Download Logs**: Tracks download activity for each file and stores logs for analytics.
- **Shareable Links**: Generates secure, password-protected links with optional expiration dates for sharing files.
- **Search and Filtering**: Enables file searching by name, type, tags, or metadata.
- **Automatic Deletion**: Cron job automatically deletes files from S3 and removes its metadata from MongoDB after the expiration date passes.
- **Notifications**: Users receive notifications (via email) before their file expires and once it's deleted.
## Tech Stack
- **Backend Framework**: Nest.js
- **Database**: MongoDB (MongoDB Atlas for cloud hosting)
- **File Storage**: Microsoft azure blob storage
- **Authentication**: JWT (JSON Web Tokens)
## Getting Started
Prerequisites
Node.js (>=14.x)
Npm (>=10.x)
### Installation
- Clone the Repository
```bash
git clone https://github.com/aifia105/file-sharing-backend.git
cd file-sharing-backend
```
- Install Dependencies
```bash
npm install
```
### Configure Environment Variables
Create a .env file in the root directory and add the following variables:
```dotenv
FRONTEND_URL
PORT
MONGODB_URI
JWT_SECRET
JWT_EXPIRATION
BCRYPT_SALT_ROUNDS
SESSION_SECRET
AZURE_STORAGE_CONNECTION_STRING
```
### Run the Server
For development:
```bash
npm run start:dev
```
For production:
```bash
npm run start
```