Added Installion Documentation

README.md

@@ -1,3 +1,47 @@
 ## Rose - HackFS 2024 Project
 
-iJack.sol on filecoin (calibration): 0xFCc61d21F57FB390b3809E5FA62fe77148BE368C
+Smart storage solution built on top of IPFS & Filecoin, benchmarking deduplication process, and optionally enabling proof of ownership using ERC721. BUIDL for humans.
+
+Our project, Rose, is a revolutionary platform designed to offer a seamless experience for storing, creating, and managing digital assets. Leveraging the power of IPFS and Filecoin, Rose ensures secure and decentralized storage for users' files while providing efficient authentication mechanisms.
+
+### Key Features
+
+- **Decentralized Storage**: Utilizing IPFS and Filecoin, Rose provides a decentralized storage solution, ensuring data integrity and availability.
+
+- **Deduplication Benchmarking**: Rose employs advanced deduplication techniques to optimize storage space and enhance performance.
+
+- **Proof of Ownership with ERC721**: For users seeking additional security and authenticity, Rose optionally enables the creation of non-fungible tokens (NFTs) using the ERC721 standard, providing immutable proof of ownership.
+
+---
+
+### Getting Started
+
+**Development Environment Setup**
+
+To configure your development environment for Rose, follow these steps:
+
+**Backend**: Rose's backend is built on Node.js.
+
+```bash
+cd backend
+cp .env.example .env
+npm install
+npm run dev
+```
+
+**Frontend**: The frontend is built using Vite.js (React).
+
+```bash
+cd frontend
+cp .env.example .env
+npm install
+npm run dev
+```
+
+Both the backend and frontend can be initialized using the command npm run dev. While we recommend using Bun.js for development, npm and yarn are also supported.
+
+### Contribution
+Contributions are welcomed after June 2, 2024. This is project is built for HackFS 2024, ETHGlobal. Please check out the [issues](https://github.com/13x54n/hackfs-rose/issues)
+
+### License
+[MIT](https://github.com/13x54n/hackfs-rose/blob/main/LICENSE) © Rose

backend/.env.example

@@ -1 +1 @@
-LIGHTHOUSE_API_KEY='91c5f7cd.33caddd9f90a4110b7d5cf798f153171'
+LIGHTHOUSE_API_KEY=

frontend/.env.example

@@ -1,9 +1,9 @@
-VITE_THIRD_WEB_CLIENT_ID='5e2dc9520e575f977819045cd67f4853'
-VITE_THIRD_WEB_SECRET_KEY='D_2KZ_rJAS551r6VP6AD37kL4Cy9rY1mjxfRBi--yx6jtZEAVAQd2qZGkvropz1RJj7rA4LOVQYiySxWvpVcng'
-VITE_LIGHTHOUSE_STORAGE_API_KEY='91c5f7cd.33caddd9f90a4110b7d5cf798f153171'
-VITE_NFT_CONTRACT_ADDRESS='0x919F805060b053458668d198e08197130504407A'
-VITE_SERVER_URI='http://localhost:3000'
-VITE_PINATA_API_KEY='e38b1392e1936d9ba90a'
-VITE_PINATA_API_SECRET='c9ffec9a41430ad6afa8bd5f7defc9bc631583cb2ca195f6d8eb6094fd098173'
-VITE_PINATA_JWT ='eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySW5mb3JtYXRpb24iOnsiaWQiOiIxMTE4MGNmMy1mYWIwLTQ3MTItYjg0OS0xODZjNzQwNjk3NWIiLCJlbWFpbCI6Im5vdC5zby5sZXh5QGdtYWlsLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJwaW5fcG9saWN5Ijp7InJlZ2lvbnMiOlt7ImlkIjoiRlJBMSIsImRlc2lyZWRSZXBsaWNhdGlvbkNvdW50IjoxfSx7ImlkIjoiTllDMSIsImRlc2lyZWRSZXBsaWNhdGlvbkNvdW50IjoxfV0sInZlcnNpb24iOjF9LCJtZmFfZW5hYmxlZCI6ZmFsc2UsInN0YXR1cyI6IkFDVElWRSJ9LCJhdXRoZW50aWNhdGlvblR5cGUiOiJzY29wZWRLZXkiLCJzY29wZWRLZXlLZXkiOiJlMzhiMTM5MmUxOTM2ZDliYTkwYSIsInNjb3BlZEtleVNlY3JldCI6ImM5ZmZlYzlhNDE0MzBhZDZhZmE4YmQ1ZjdkZWZjOWJjNjMxNTgzY2IyY2ExOTVmNmQ4ZWI2MDk0ZmQwOTgxNzMiLCJpYXQiOjE3MTY3NDc2NTN9.4Cj-oxlGg9A9l__z7Tz9V5ZlBG_sIz3mVAB5JDKTnxo'
-VITE_LIGHTHOUSE_GATEWAY='https://gateway.lighthouse.storage/ipfs'
+VITE_THIRD_WEB_CLIENT_ID=
+VITE_THIRD_WEB_SECRET_KEY=
+VITE_LIGHTHOUSE_STORAGE_API_KEY=
+VITE_NFT_CONTRACT_ADDRESS=
+VITE_SERVER_URI=
+VITE_PINATA_API_KEY=
+VITE_PINATA_API_SECRET=
+VITE_PINATA_JWT =
+VITE_LIGHTHOUSE_GATEWAY=