Skip to content

beckn/beckn-utilities

Repository files navigation

Beckn Utilities

Welcome to the Beckn Utilities repository! This repository houses multiple utility projects aimed at assisting developers in various tasks related to the Beckn protocol and related technologies. Below is an overview of the utilities included in this repository along with their respective version, release notes, and documentation links.

Utilities Overview

Utility Name Version Release Note Documentation
Beckn Spec Validator v1.0.0 Added support for new validation rules. Documentation
Industry 4.0 Machine Simulator v1.0.0 Fixed bugs related to simulation accuracy. Documentation
Observer Server v1.0.0 Improved performance and added new APIs. Documentation
ONIX v0.2.0 Release Notes Documentation

Getting Started

Each utility has its own set of instructions for installation, configuration, and usage. Please refer to the documentation links provided above for detailed information on how to use each utility.

Recommendations on what goes into this repo

  • It should not have any project that has github integration in its workflow (e.g. projects that automatically deploy on server when we checkin code etc). The reason is that it might be difficult to configure and the workflow will be triggered when unrelated files are modified.
  • It should not have any project that has Continuous Deployment component. Again similar to 1 above. It will involve deployment when unrelated files are modified.
  • It should not have any project that will involve large community component. The reason here simply is that we will be asking users to get unrelated code onto their workspace.
  • It should not be used for projects which have binary assets such as images, pdf files etc. The reason is that in text based SCM tools, these are usually kept as is without diff and so the overall repo size will be high.
  • It can be used for small tools that have their own publishing workflow (e.g. npm libraries)
  • It can be used for internal tools and projects which involves very few developers (preferably only internal)
  • When in doubt, I think we should use separate repo.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published