Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/readme #78

Merged
merged 2 commits into from
Dec 15, 2024
Merged

Fix/readme #78

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4fa0812
fix: remove instances of npm, since it doesn't currently work generally
temi0x Dec 6, 2024
c37471e
fix: add storacha instructions
temi0x Dec 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 35 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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:

Expand Down Expand Up @@ -74,20 +75,21 @@ Ensure you have the following installed:

### From source code

### From source code

1. Clone the repository

```bash
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
Expand All @@ -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:
Expand All @@ -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

Expand Down Expand Up @@ -173,13 +169,6 @@ yarn compile
yarn deploy
```

or

```bash
npm compile
npm deploy
```

### Running the Frontend

To start the Next.js frontend:
Expand All @@ -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)

Expand All @@ -212,11 +195,35 @@ 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.*

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.
Expand All @@ -235,7 +242,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/
Expand Down
Loading