NFTopia Backend API

NFTopia Backend API is a Nest.js application that powers the NFTopia platform's server-side operations. It provides RESTful endpoints for NFT management, user authentication, and blockchain interactions with Starknet.

---

🔗 API Documentation

View Swagger Docs (Available when running locally)

---

✨ Backend Features

• JWT Authentication: Secure user login and session management
• NFT Metadata Processing: IPFS upload and metadata generation
• Starknet Integration: Interact with Cairo smart contracts
• Database ORM: TypeORM with PostgreSQL for data persistence
• Queue System: BullMQ for background jobs (minting, notifications)
• API Rate Limiting: Protect against abuse

---

🛠️ Tech Stack

Component	Technology
Framework	Nest.js
Language	TypeScript
Database	PostgreSQL + TypeORM
Blockchain	Starknet.js
Queue	BullMQ
API Docs	Swagger

---

🚀 Quick Start

Prerequisites

• Node.js v18+
• PostgreSQL 14+
• Redis (for queues)
• pnpm

Installation

1. Clone the repo:

   git clone https://github.com/NFTopia-Foundation/nftopia-backend-api.git
   cd nftopia-backend-api

2. Install dependencies:

   pnpm install

3. Setup environment:

   cp .env.example .env

🤝 Contributing

1. Fork the repository
2. Create your feature branch:

git checkout -b feat/your-feature

3. Commit changes following Conventional Commits
4. Push to the branch:

5. Open a Pull Request