From 4fa0812bc29ed578ffb09cb6fcb97b639305ff1d Mon Sep 17 00:00:00 2001 From: temi0x Date: Fri, 6 Dec 2024 19:12:09 +0100 Subject: [PATCH 1/2] fix: remove instances of npm, since it doesn't currently work generally --- README.md | 38 +++++++++++--------------------------- 1 file changed, 11 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 92d5411..7828b13 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Welcome to FIL-Frame, a starter repository designed to help developers quickly g ## Table of Contents 📚 - [FIL-Frame](#fil-frame) - - [Table of Contents](#table-of-contents) + - [Table of Contents 📚](#table-of-contents-) - [Overview](#overview) - [Unique Features](#unique-features) - [Getting Started](#getting-started) @@ -27,11 +27,12 @@ Welcome to FIL-Frame, a starter repository designed to help developers quickly g - [Storage Onramp Options](#storage-onramp-options-1) - [Lighthouse](#lighthouse) - [Storacha](#storacha) + - [Akave](#akave) - [Project Structure](#project-structure) - [Contributing](#contributing) - [License](#license) -## Overview 🌐 +## Overview FIL-Frame is a monorepo that includes two main packages: @@ -74,8 +75,6 @@ Ensure you have the following installed: ### From source code -### From source code - 1. Clone the repository ```bash @@ -83,11 +82,14 @@ git clone https://github.com/FIL-Builders/fil-frame cd fil-frame ``` -2. (Optional) Switch to a different starter kit branch +2. (Optional) Switch to a different starter kit branch. + Available branches include: `lighthouse-nfts`: Integration with Lighthouse for decentralized storage. + `storacha-nfts`: Integration with Storacha for decentralized storage. + `akave-integration`: Integration with Akave for decentralized storage. 3. Install dependencies @@ -96,12 +98,6 @@ Available branches include: yarn install ``` -or - -```bash -npm install -``` - ### Configuration 1. Copy the sample environment files, and fill in the required values: @@ -125,7 +121,7 @@ To use the interactive mode, simply run: npx create-filecoin-app ``` -You will be prompted to answer a series of questions to configure your new project. This includes your project name, and selecting your preferred storage onramp option (Lighthouse, or Storacha). +You will be prompted to answer a series of questions to configure your new project. This includes your project name, and selecting your preferred storage onramp option (Lighthouse, Storacha, or Akave). #### Flag Mode @@ -173,13 +169,6 @@ yarn compile yarn deploy ``` -or - -```bash -npm compile -npm deploy -``` - ### Running the Frontend To start the Next.js frontend: @@ -188,12 +177,6 @@ To start the Next.js frontend: yarn dev ``` -or - -```bash -npm run dev -``` - The application will be available at [`https://localhost:3000`](https://localhost:3000) @@ -212,12 +195,13 @@ To use this integration: 2. Ensure you add the Lighthouse API key set in your `.env.local` file: `LIGHTHOUSE_API_KEY=your_lighthouse_api_key` 3. then you can started the fil-frame app with command: -`yarn dev` or `npm run dev` +`yarn dev` 4. Use the provided integration to upload files to Lighthouse ### Storacha *Coming soon.* + ### Akave To use fil-frame with Akave integration, you need to follow the instructions to setup the env to use Akave to store data for your projects. - Make sure you install and run docker in your machine. @@ -235,7 +219,7 @@ To use fil-frame with Akave integration, you need to follow the instructions to To learn more how to use Akave to create bucket and upload on front-end, visit [Akave docs](https://hackathon-docs.akave.ai/js-docker-example-code#bucket-operations). -## Project Structure 🗂️ +## Project Structure ``` my-app/ From c37471eec8ada3baafa29ee8d214f71b24838996 Mon Sep 17 00:00:00 2001 From: temi0x Date: Fri, 6 Dec 2024 19:24:57 +0100 Subject: [PATCH 2/2] fix: add storacha instructions --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7828b13..2e01ba9 100644 --- a/README.md +++ b/README.md @@ -199,8 +199,31 @@ To use this integration: 4. Use the provided integration to upload files to Lighthouse ### Storacha -*Coming soon.* +The repository includes a template which makes use of Storacha for uploading files and directories to IPFS. + +To use this integration: + +1. Switch to the `storacha-nfts` branch: + - To switch the active branch to the `storacha-nfts` branch, run: + + ```bash + git checkout storacha-nfts + ``` + +2. Deploy Your NFT Contract: + - Follow the instructions in the [Hardhat README](packages/hardhat/README.md) (in the storacha-nfts branch) to deploy your NFT contract on the Calibration network. + +3. Set Up Your Application: + - Navigate to the [Next.js README](packages/nextjs/README.md) to set up your application for uploading files and directories using Storacha. + +4. Using Storacha Functionalities: + - If you only need the functionalities to upload files to Storacha, complete the setup in the [Next.js README](packages/nextjs/README.md). + - Copy the `app/api` folder from [packages/nextjs/app/api](packages/nextjs/app/api). + - Include the Storacha hooks from [packages/nextjs/hooks/storacha](packages/nextjs/hooks/storacha). + - Integrate the frontend code for file inputs from [storachaUpload.tsx](packages/nextjs/app/storacha/_components/storachaUpload.tsx). + +* Ensure you have the necessary dependencies and configurations as outlined in the respective README files. ### Akave To use fil-frame with Akave integration, you need to follow the instructions to setup the env to use Akave to store data for your projects.