Git Product home page Git Product logo

beckn-registry-app's Introduction

Project Introduction

Beckn Registry application This is skeletal succinct application. that uses the plugin beckn-registry.

Release Notes

Version Release Date
1.0 2024-02-02

Installation/Setup Guide

You need to Clone and build the following repositories (using mvn install in each of the directories) in sequence

  1. Common
  2. Beckn SDK for Java
  3. Succinct Web Framework
  4. Beckn registry plugin.

Then clone this repo you are reading ;

  1. Go into the cloned folder. cd beckn-registry-app

  2. Copy sample overrideProperties.sample to overrideProperties; cp -R overrideProperties.sample overrideProperties

  3. Locate swf.propeties file in overrideProperties and edit the section pertaining to "Beckn Gateway configurations".

  4. from the base directory for beckn-registry-app , run bin/swfstart

Your registry will be up. check logs in tmp/ folder to see if there are any issues and resolve them

User Guide

Link to Experience Center

Beckn registry

Contributing guidelines

  1. Fork the repository in your repository.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your contribution: git checkout -b feature/your-feature-name
  4. Make your changes and commit them: git commit -m "Your commit message"
  5. Push to the branch: git push origin feature/your-feature-name
  6. Submit a pull request to the main repository.

Code Style and Standards

  • Follow the coding style and standards used in the project.
  • Use meaningful variable and function names.
  • Write clear and concise comments when necessary.
  • Ensure your code is well-documented.

Testing

  • Ensure your changes pass all existing tests.
  • Write additional tests if necessary to cover your changes.
  • Run the test suite before submitting a pull request.

Reporting Bugs

If you find a bug, please report it by opening an issue on GitHub. Include as much detail as possible, such as the steps to reproduce the bug and your environment details.

Feature Requests

If you have an idea for a new feature or improvement, feel free to open an issue to discuss it. Provide a clear description of the feature and why it would be beneficial.

Pull Request Guidelines

  • Provide a clear and descriptive title for your pull request.
  • Include a detailed description of the changes you've made.
  • Reference any related issues in your pull request.
  • Ensure your code is properly tested.

beckn-registry-app's People

Contributors

venkatramanm avatar prasad-takale-eminds avatar vishi24 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.