Skip to content

fless-lab/file-nest-usage-example

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FileNest Usage Example

This project demonstrates the usage of FileNest, a secure and user-friendly file storage service. FileNest allows you to store and retrieve files securely, offering advanced features such as HMAC signature management to ensure data integrity.

Demo Video

Watch the demo video for a visual presentation of FileNest and its usage in this example.

Prerequisites

Make sure you have Node.js and npm installed on your machine before starting. Don't forget to configure the HMAC secret key in your application's environment file.

# Example HMAC secret key configuration
HMAC_SECRET=YourSecretKey

Backend (API) ✔️

The backend of this example is built with Node.js, Express, and MongoDB. It uses FileNest for file storage. To set up and run the backend, follow these steps:

  1. Navigate to the backend directory.
cd backend
  1. Install dependencies.
npm install
  1. Start the server.
npm start

The backend will be accessible at http://localhost:5000.

Frontend (React) ✔️

The frontend is built with React and Tailwind CSS. To set up and run the frontend, follow these steps:

  1. Navigate to the frontend directory.
cd frontend
  1. Install dependencies.
npm install
  1. Start the application.
npm start

The frontend application will be accessible at http://localhost:3000.


Note: File Nest should already be running. Check the FileNest README for more information on how to set it up 👉 FileNest Readme


Demonstrated Features

  • File Upload
  • File Retrieval
  • File Deletion ⏳
  • Permanent File Deletion ⏳
  • File Restoration ⏳

Contribute

We actively encourage contributions to this project. If you find issues, bugs, or have improvement suggestions, feel free to open an issue or submit a pull request.

Also, make sure to check out the FileNest repo for more information on this powerful file storage service.

About

This project showcase the usage of the File Nest with a real world example

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published