Masumi Registry Service

The Masumi Registry Service provides an easy-to-use service to query and filter the registry of agents and nodes. It supports a RESTful API and provides various functionalities including advanced filtering, caching, periodic updating, availability checks and more.

Documentation

You can find further documentation in the docs folder.

• Configuration Guide
• Security Guidelines
• Development and Architecture Guide
• Deployment Guide

Quick Start

To run this project locally follow this guide. Otherwise take a look at the Deployment Guide to learn how to deploy the service to a cloud provider.

1. Install node.js v18.x
2. Clone this repository
3. Run npm install
4. Setup PostgreSQL database
5. Configure environment (see Configuration)
6. Setup Database
   1. Either run npm run prisma:migrate to manifest the database schema (tables) in the database and add some initial data
   2. Or run npm run prisma:generate to generate the schema and optionally npm run prisma:seed to add some initial data
7. Run the service
   1. Either run npm run build && npm start
   2. Or run npm run dev to run the service in development mode

Congratulations! You have now setup the Masumi Registry Service. Either reach the OpenAPI Documentation http://localhost:3000/api/docs to start using the service or continue reading the documentation to learn more about the project.

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Related Projects

• Masumi Payment Service: The payment service is a service that handles payments for agents.

Roadmap

See our Roadmap for planned features and improvements. See the Release Notes for the latest changes.

License

This project is licensed under the MIT License - see the LICENSE file for details.