Skip to content

0xPolygonID/js-issuer-template

Repository files navigation

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Discord Backers on Open Collective Sponsors on Open Collective Donate us Support us Follow us on Twitter

Verifiable Credential Studio

A NestJS-based service for issuing and verifying digital credentials using Polygon ID.

Description

VC Studio enables the creation, issuance, and verification of verifiable credentials based on the Polygon ID ecosystem. It provides API endpoints for credential management, identity verification, and agent communication.

Features

  • Issue and verify verifiable credentials
  • Agent communication through standardized protocols
  • Ethereum address ownership verification
  • Secure message handling and encryption

Project Setup

# Install dependencies
$ pnpm install

# Configure environment
$ cp .env.example .env
# Edit .env with your configuration

Running the Application

# Development mode
$ pnpm run start:dev

# Production mode
$ pnpm run start:prod

API Endpoints

Agent Endpoint

POST /agent Handles agent communications including credential requests and message handling.

Callback Endpoint

POST /callback Used for credential issuance callbacks.

Testing

# Run tests
$ pnpm run test

# Run e2e tests
$ pnpm run test:e2e

API Examples

You can find example API requests in the .api/api.rest file, which can be executed using REST Client extensions in VS Code or similar tools.

Deployment

When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the deployment documentation for more information.

If you are looking for a cloud-based platform to deploy your NestJS application, check out Mau, our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:

pnpm install -g @nestjs/mau
mau deploy

With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.

Resources

Check out a few resources that may come in handy when working with NestJS:

  • Visit the NestJS Documentation to learn more about the framework.
  • For questions and support, please visit our Discord channel.
  • To dive deeper and get more hands-on experience, check out our official video courses.
  • Deploy your application to AWS with the help of NestJS Mau in just a few clicks.
  • Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
  • Need help with your project (part-time to full-time)? Check out our official enterprise support.
  • To stay in the loop and get updates, follow us on X and LinkedIn.
  • Looking for a job, or have a job to offer? Check out our official Jobs board.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

License

This project is MIT licensed.

About

Issuer template based on the JS SDK, using AWS UniquenessCredential issuance as an example.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published