Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pinatacloud/ipfs-api-starter
https://github.com/pinatacloud/ipfs-api-starter
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/pinatacloud/ipfs-api-starter
- Owner: PinataCloud
- Created: 2024-11-11T19:56:35.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-11-14T15:16:59.000Z (about 1 month ago)
- Last Synced: 2024-11-14T16:26:38.005Z (about 1 month ago)
- Language: TypeScript
- Size: 5.86 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ipfs-api-starter
This repo includes some basic API calls to help get you started using the IPFS API.
**Watch the video!**
[](https://www.youtube.com/watch?v=qarW5KhIWXE)
> [!TIP]
> If you plan to use Pinata in a Typescript/Javascript enviornment, check out our [SDK](https://github.com/PinataCloud/pinata)!
## Getting Started
First follow [these steps](https://docs.pinata.cloud/quickstart) to make a free Pinata account and get your API key and Gateway URL
By default this repo will use [Bun.sh](https://bun.sh) so install this first unless you plan to run the files with another program.
Clone the repo to your machine and install the dependencies
```bash
git clone https://github.com/PinataCloud/files-api-starter
cd files-api-starter
bun install
```
Rename the `.env.example` file to `.env` and paste in your Pinata JWT API key and Gateway URL
```
PINATA_JWT=
GATEWAY_URL=
```
## Usage
Start using the API by running the following:
```
bun upload-files.ts
```
Continue testing by running the other files included in the repo