Skip to content

AMRIT API microservice for generation and management of unique beneficiary IDs.

License

Notifications You must be signed in to change notification settings

PSMRI/BeneficiaryID-Generation-API

Repository files navigation

AMRIT - BeneficiaryID-Generation-API Service

License: GPL v3 branch parameter

This service is used to generate unique beneficiary registration Id for new beneficiaries.

Building From Source

This microservice is built on Java, Spring boot framework and MySQL DB.

Prerequisites

  • JDK 1.8
  • Maven
  • Wildfly (or any compatible app server)
  • Redis
  • MySQL Database

Installation and setup

Please follow these steps:

  1. Clone the repository to your local machine.
  2. Install the dependencies and build the module:
    • Run the command mvn clean install.
  3. You can copy bengen_example.properties to bengen_local.properties and edit the file accordingly. The file is under src/main/environment folder.
  4. Run the development server:
    • Start the Redis server.
    • Run the command mvn spring-boot:run -DENV_VAR=local.
  5. Open your browser and access http://localhost:8080/swagger-ui.html#!/ to view the Swagger API documentation.

Usage

All features have been exposed as REST endpoints. Refer to the SWAGGER API specification for details.

Filing Issues

If you encounter any issues, bugs, or have feature requests, please file them in the main AMRIT repository. Centralizing all feedback helps us streamline improvements and address concerns efficiently.

Join Our Community

We’d love to have you join our community discussions and get real-time support!
Join our Discord server to connect with contributors, ask questions, and stay updated.

About

AMRIT API microservice for generation and management of unique beneficiary IDs.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages