/vendure

Becknize Vendure framework shops and marketplaces

Primary LanguageTypeScript

Project Introduction

The Vendure plugin serves as a powerful tool designed to seamlessly integrate the Vendure e-commerce application with the Beckn ecosystem. It enables businesses to enhance their e-commerce operations by leveraging Beckn standards across all phases of the cycle.

The Vendure plugin offers comprehensive support throughout the e-commerce cycle, including discovery, fulfillment, and post-fulfillment stages. By incorporating Beckn standards, businesses can streamline their processes and provide a seamless shopping experience for customers.

With the Vendure plugin, businesses can optimize product discovery by utilizing Beckn's standardized protocols. This enables them to effectively showcase their products to potential customers, increasing visibility and driving sales.

The plugin integrates Beckn standards into Vendure's order fulfillment workflows, ensuring efficient order processing and delivery. From order placement to shipment tracking, businesses can meet customer expectations and improve satisfaction.

In addition to order fulfillment, the plugin supports post-fulfillment activities such as returns and exchanges. By adhering to Beckn standards, businesses can effectively manage customer inquiries and resolve issues, fostering trust and loyalty.

Detailed readme for the plugin

Refer Beckn Vendure Plugin README for details on setting up the Beckn Vendure Plugin and related documents.

Importing catalogs into Vendure

Refer to Catalog.md for details on importing catalog into Vendure shops.

Features

Single Shop and Multi-Seller, Multi-Tenant Mode

The platform offers versatility by accommodating both single-shop and multi-seller, multi-tenant modes of operation. Whether operating as an independent storefront or a comprehensive marketplace with multiple sellers and tenants, the platform provides robust features to meet diverse business needs.

Full Support for Beckn Endpoints

With comprehensive integration of all Beckn endpoints, the platform ensures seamless communication and interoperability within the Beckn ecosystem. By adhering to Beckn standards, businesses can effortlessly connect and engage with partners and services across the network, enhancing efficiency and collaboration.

Digital Product Compatibility

In addition to physical goods, the platform supports the sale and distribution of digital products. Businesses can offer a diverse range of digital content, including e-books, software, and media files, providing customers with access to a wider array of products and services.

Bridge between Stateless Beckn and Session-Based Vendure

The platform serves as a bridge between the stateless architecture of Beckn and the session-based framework of Vendure. By harmonizing the functionalities of both systems, the platform leverages Beckn's decentralized approach and Vendure's session management capabilities to deliver a seamless and scalable e-commerce solution.

Technical stack

Node

Release Notes

Name Version
vendure Plugin 1.0.0

Installation/Setup Guide

User Guide

NA

Link to Experience Center

NA

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.