Skip to content

Getting Started

Try It Online

You can try the NFT Platform API service online at NFT Platform.

You can also run the NFT Platform API service locally on your machine by following the instructions in the Local Development section.

Features

The NFT Platform API server consists of the following features:

  • Create and manage NFT collections
  • Mint and manage NFTs on various blockchain networks
  • Implement a robust access control system with roles and scopes
  • Track user activities and maintain a record of all events
  • Generate and manage API keys for secure authentication and authorization
  • Manage user subscriptions and pricing plans
  • Send and manage custom notifications to users

API Integration

To integrate the NFT platform API service into your application, refer to the API Integration section of the documentation.

Local Development

Installation

Prerequisites

  • Node.js version 18 or higher.
  • Text Editor (VSCode is recommended).

To get started with NFT Platform, simply follow the installation instructions

- OR -

  1. Clone the repository:
bash
git clone https://github.com/trackgenesis/nft-platform-server.git
  1. Navigate to the project directory:
bash
cd nft-platform-server
  1. Install Dependencies
bash
npm install
  1. Start Server

NOTE

Before you can start using the NFT Platform API service, you need to do create a .env file in the root of the project.

You can find a sample .env.example file in the root of the project. Update the values in the .env file to match your environment.

bash
npm run dev

The server will start on port 3000. You can access it by navigating to http://localhost:3000 in your web browser.

API Documentation created with ❤️ by TrackGenesis