timescaletimescale
112

Nft Starter Kit

screenshot of Nft Starter Kit

Timescale NFT Starter Kit

GithubDemo

Overview

The Timescale NFT Starter Kit is a comprehensive guide that helps users collect, store, analyze, and visualize NFT (Non-Fungible Token) data from OpenSea. It utilizes PostgreSQL and TimescaleDB to provide a solid foundation for analyzing NFT trends and making data-driven purchasing decisions.

Features

  • Design database schema: Provides a relational schema for storing NFT sales, assets, collections, and accounts.
  • Get data: Includes an ingestion script for collecting historical data from OpenSea and ingesting it into TimescaleDB. Sample data is also available for quick start.
  • Build dashboards: Offers a Streamlit dashboard for analyzing collection sales and a Grafana dashboard template file for storing and analyzing NFTs.
  • Analyze data: Provides sample queries to serve as starting points for custom analysis.

Setting up the pre-built Superset dashboards

  1. Ensure you have Docker and Docker compose installed.
  2. Clone the repository.
  3. Open a terminal and navigate to the /pre-built-dashboards folder.
  4. Run the command docker-compose up --build.
  5. Wait for the process to complete.
  6. Open your browser and go to http://0.0.0.0:8088/.
  7. Login using the provided credentials.
  8. Access the Databases page inside Superset at http://0.0.0.0:8088/databaseview/list/.
  9. Check the NFT Starter Kit item in the list.
  10. Explore the NFT dashboards: Collections dashboard (http://0.0.0.0:8088/superset/dashboard/1) and Assets dashboard (http://0.0.0.0:8088/superset/dashboard/2).

Running the data ingestion script

  1. Make sure you have Python 3 and TimescaleDB installed, with the schema set up using the schema.sql script.
  2. Navigate to the root folder of the project.
  3. Create a new Python virtual environment and install the requirements.
  4. Replace [command] with the appropriate command for your environment and execute it:
[command] -m venv nft-env
source nft-env/bin/activate
pip install -r requirements.txt
  1. Run the data ingestion script using the appropriate command for your environment.

Summary

The Timescale NFT Starter Kit is a comprehensive resource for analyzing and visualizing NFT data from OpenSea. It provides various components, including a database schema, data ingestion script, sample data, dashboards, and sample queries. The installation process involves setting up the pre-built Superset dashboards using Docker and running the data ingestion script. Users can utilize this kit to gain insights into NFT trends and make informed purchasing decisions.