Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 2.3 KB

README.md

File metadata and controls

38 lines (27 loc) · 2.3 KB
Raw

iDempiere Examples Repository

Welcome to the iDempiere Examples Repository! This repository contains a collection of examples and best practices for writing code and plugins for the iDempiere ERP system. Whether you are new to iDempiere or an experienced developer, these examples will help you understand how to extend and customize iDempiere to meet your business needs.

Purpose

The purpose of these examples is to help with the following:

  • Offer you a quick start option to get something up and running quickly. You should be able to copy an existing directory into your project and make use of it as-is.
  • Demonstrate current best practices for a given interface. Over the last 13+ years, the method by which you code against an interface has evolved.
  • Create consistency within a team of developers. There are times when you need a team to create plugins in a current and consistent way. This repository makes it easy to establish practices per team and/or per project.

Creating New Plugins in Principle

When speaking with @carlosruiz, his practice is to:

  1. Look for a similar plugin in an existing project to copy, modify and deploy.
  2. If no local examples exist, use the examples in this repository as the starting point.

Getting Started

  1. clone this repository locally
  2. copy the desired example into your project
  3. use this page as a guide to determine what files need to change and to get your plugin running: https://wiki.idempiere.org/en/Developing_Plug-Ins_-_Get_your_Plug-In_running
    1. todo: is this the right set of instructions?
  4. To ensure all files have changed, search the plugin for the term "example".
  5. Modify the example class according to your needs.

Contributing

We welcome contributions to this repository! If you have an example or a best practice to share, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your example.
  3. Commit your changes and push the branch to your fork.
  4. Open a pull request with a description of your new example.

Please ensure your code follows the iDempiere coding standards and includes comments and documentation where necessary.

Discussion

If you wish to discuss, modify or add to this repository, visit the team on https://mattermost.idempiere.org.