Table of Contents

• BDM Queries
  • 1. Features
  • 2. Getting started
  • 3. Developing
    • 3.1. Building
    • 3.2. Deploying / Publishing
  • 4. Configuration
    • 4.1. page.properties
    • 4.2. configuration.properties
  • 5. Contributing
  • 6. Links

BDM Queries

My Rest API extension description

The project bdmQueries is a Bonita REST API extension for Bonita 7.13 version community written in groovy language.

TODO: A brief description of your project, what it is used for and how does life get awesome when someone starts to use it.

1. Features

TODO: What’s all the bells and whistles this project can perform?

• What’s the main functionality

• You can also do another thing

• If you get really randy, you can even do this

2. Getting started

TODO: A quick introduction of the minimal setup you need to get a hello world up & running. For more details on Bonita REST API extension please refer to documentation

3. Developing

TODO: Here’s a brief intro about what a developer must do in order to start developing the project further:

Prerequisite:

• a git client

• a java ( jdk 11 or higher)

• maven (optional if you choosed to use maven wrapper script as archetype option)

3.1. Building

TODO: If your project needs some additional steps for the developer to build the project after some code changes, state them here:

git clone https://your.github.com/bdmQueries.git
cd bdmQueries/
./mwnw package

The build should produce a zip archive under the target/ folder named bdm-queries-rest-api-1.0-SNAPSHOT.zip

TODO: Here again you should state what actually happens when the code above gets executed.

For more details about apache maven, please refer to the documentation

3.2. Deploying / Publishing

TODO: In case there’s some step you have to take that publishes this project to a server, this is the right time to state it.

Take the built artifact bdm-queries-rest-api-1.0-SNAPSHOT.zip and upload it to your Bonita platform (see rest-api-extension deployment)

4. Configuration

TODO: Here you should write what are all of the configurations a user can enter when using the project.

4.1. page.properties

link:src/main/resources/page.properties[role=include]

4.2. configuration.properties

link:src/main/resources/configuration.properties[role=include]

5. Contributing

TODO: Make easy to your team to jump in and start contributing to your project.

These paragraphs are meant to welcome those kind souls to feel that they are needed. You should state something like:

"If you’d like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome."

If there’s anything else the developer needs to know (e.g. the code style guide), you should link it here. If there’s a lot of things to take into consideration, it is common to separate this section to its own file called CONTRIBUTING.adoc (or similar). If so, you should say that it exists here.

6. Links

TODO: Even though this information can be found inside the project on machine-readable format like in a .json file, it’s good to include a summary of most useful links to humans using your project. You can include links like:

1. Project homepage: https://your.github.com/awesome-project/

2. Repository: https://github.com/your/awesome-project/

3. Issue tracker: https://github.com/your/awesome-project/issues

   1. In case of sensitive bugs like security vulnerabilities, please contact [email protected] directly instead of using issue tracker. We value your effort to improve the security and privacy of this project!