Storz

Winner of Decentralized Storage Infrastructure & Community Choice Award of Web3 Infinity Hackathon 2022 organized by Protocol Labs, Filecoin Foundation & Force Web3 Community.

💁 About The Project

Storz is a fully-decentralized, open source, usable-design-focused, storage application that is built to replace current storage providers in the market.

Features of our application:

• Store unlimited files

• Share your files to anyone

• Ability to make the file public or private

• All the files are encrypted using AES-256 Algorithm

• Files are stored in IPFS , a high performance distributed server network protocol

• Passwordless Authentication

• Complete ownership of the data

• User friendly interface

• Fast, Reliable and Secure

• Built on Modern and Well-used Technologies like React, IPFS, MongoDB & NodeJS

(back to top)

📸 Screenshots

Here is a sneak peek of the application and it's visuals 😍:

Landing Page
Login	Home Page
My Files	File Description
Features

(back to top)

✅ Quick Start Guide

To get started with having your own instance of Storz, follow the steps described in the following section

💯 Prerequisites ( Important )

You will need these to be already installed:

• NodeJS version 16+
• NPM version 8+

And that's it

💾 Installation

Follow these steps to get started

Installation

# Clone the repository
git clone https://github.com/anomic30/Storz.git
# Enter into the frontend directory
cd Storz/client
# Install the dependencies
npm install
# Enter into the server directory
cd Storz/server
# Install the dependencies
npm install

⚠️ Important!

In order to get the API keys check out client/README.md & server/README.md

Starting the application

# To run the frontend OR backend
npm start
# To build the frontend
npm run build

(back to top)

📐 How it works

Here's a diagram explaining exactly how everything fits into place

(back to top)

🤝🏻 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)