Project Title

This is a serverless Typescript Node Project to work with NFTS

Features

• Mint NFTS
• List all NFTS
• Get details of a NFTS

Tech Stack

Server: Node, Express, Serverless, AWS Lambda, AWS Dynamodb

Run Locally

Clone the project

  git clone https://link-to-project

Go to the project directory

  cd mintable-app

Install dependencies

  npm install

Start the server as serverless

  npm run local-serverless

Start the server as Node server

  npm run dev

Deployment

To deploy this project run

  npm run deploy

Demo

Endpoint is deployed at

https://t65m3ezdq9.execute-api.ap-southeast-1.amazonaws.com/dev

API Reference

Swagger UI

Swagger UI is available at http://localhost:3000/api-docs when you run Node without Serverless

Architecture of the code

Live Link to the diagram

  npm run dev

Get all NFTS

  GET /ntfs

Parameter	Type	Description
api_key	string	Required. Your API key

Get item

  GET /ntfs/:{id}

Parameter	Type	Description
id	string	Required. Id of NFT to fetch

Get item

  POST /ntfs/:{id}

Body	Type	Description
name	string	Required. name of NFT to mint
imageUrl	string	Required. imageUrl of NFT to mint
description	string	Required. Id of NFT to mint

  POST /authentication/login

Body	Type	Description
username	string	Required. username of user
password	string	Required. hashed password of user

  POST /authentication/validate

Header	Type	Description
authorization	string	Required. token of user

Appendix

If you would choose to deploy this in a AWS Lambda of your account. Please ensure a few things

1. Create credentials with sufficient rights to deploy the serverless code
2. Set up of AWS credentials on your machine including the region
3. Please create a DynamoDB table called NFTs in the SAME REGION as the lambda being deployed

Please note that deploying the code to serverless locally or on cloud will append a stage name to the api.

For example, http://localhost:3000/ntfs will become http://localhost:3000/dev/ntfs