Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spheronfdn/metadata-uploader
https://github.com/spheronfdn/metadata-uploader
Last synced: about 5 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/spheronfdn/metadata-uploader
- Owner: spheronFdn
- Created: 2023-11-24T20:48:38.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2023-11-28T21:36:51.000Z (12 months ago)
- Last Synced: 2024-04-02T15:17:09.749Z (8 months ago)
- Language: JavaScript
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Spheron Storage Example
## Overview
This repository provides a step-by-step guide on using the Spheron Storage SDK to upload and retrieve metadata on the decentralized web through IPFS. Metadata is essential for various use cases, including creating dynamic NFTs and storing data securely on a decentralized network.
## Table of Contents
- [Prerequisites](#prerequisites)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Medium Article](#medium-article)
- [License](#license)
- [Acknowledgments](#acknowledgments)
## Prerequisites
Before you begin, make sure you have the following installed:
- [Node.js](https://nodejs.org/) (version 12 or higher)
- [npm](https://www.npmjs.com/) (Node Package Manager)
You'll also need a Spheron authentication token. You can obtain this token by signing up on the [Spheron website](https://spheron.network/) and generating an API key.
## Getting Started
1. Clone this repository to your local machine:
```bash
git clone https://github.com/spheronFdn/metadata-uploader.git
```
2. Navigate to the repository directory:
```bash
cd spheron-storage-example
```
3. Install the required dependencies:
```bash
npm install
```
3. Open the index.js file and replace the token variable with your Spheron authentication token.
## Usage
To run the example code, execute the following command:
```bash
node index.js
```
This command will upload a sample JSON file to IPFS using the Spheron Storage SDK, fetch it, and display the uploaded data in the console.
## License
This project is licensed under the MIT License - see the LICENSE file for details.
## Acknowledgments
Spheron for providing the Spheron Storage SDK.
Feel free to explore the code and customize it for your own use cases. If you have any questions or feedback, please don't hesitate to open an issue or reach out.
Happy coding!