⚡︎ Meilisearch+

|:------------------------------------------------------:  |
| ⚡︎ B o x L a n g ⚡︎
| Dynamic : Modular : Productive
|:------------------------------------------------------:  |

Copyright Since 2023 by Ortus Solutions, Corp
www.boxlang.io | www.ortussolutions.com

Meilisearch search engine API integration

This template can be used to create Ortus based BoxLang Modules written in BoxLang. To use, just click the Use this Template button in the github repository: https://github.com/ortus-boxlang/boxlang-module-template-bx and run the setup task from where you cloned it.

boxlang SetupTemplate.bx

The SetupTemplate task will ask you for your module name, id and description and configure the template for you! Enjoy!

Directory Structure

Here is a brief overview of the directory structure:

.github/workflows - These are the github actions to test and build the module via CI
.vscode - VScode additions
bifs - Where you can code Built in Functions for BoxLang
components - Where you can code BoxLang components
interceptors - Where you can code BoxLang interceptors
lib - Place any Jar's or classes for your module that will be class loaded for you
.cfformat.json - A format config using the Ortus Standards
.editorconfig - Smooth consistency between editors
.gitattributes - Git attributes
.gitignore - Basic ignores. Modify as needed.
.markdownlint.json - A linting file for markdown docs
box.json - The box.json for your module used to publish to ForgeBox
changelog.md - A nice changelog tracking file
CONTRIBUTING.md - A contribution guideline
ModuleConfig.bx - Your module's configuration file
readme.md - Your module's readme. Modify as needed.

Local Building

The Build.bx is used to package your module so it can be distributed to FORGEBOX or to a friend. It will create a zip file in the build directory with the name of your module and the version number. The zip file will contain all the files needed to run your module, including the box.json file, the ModuleConfig.bx file, and any other files you have in your module.

If you want to build the module, you can use boxlang Build.bx to build the module. Here are the options you can pass to the script:

Option	Required	Default Value	Description
`version`	No	`1.0.0`	The version of the module.
`branch`	No	`development`	The branch being built.
`buildId`	No	UUID (generated)	A unique identifier for the build.

boxlang Build.bx --version=1.1.0

Version Management

This module uses SemVer for versioning. The version is stored in the box.json file and is used to publish to FORGEBOX and the GithubActions will atuomatically bump it for you. The version is also used to tag the repo for releases.

Github Actions Automation

This repo has all kinds of automation for PRs, snapshots, tests and releases. Use them as you see fit. If you will be doing FORGEBOX publishing, then you will need to set up a FORGEBOX API key in the secrets of your repository.

FORGEBOX_API_TOKEN - This is your FORGEBOX API key. You can get it from your FORGEBOX account settings. This is used to publish to FORGEBOX.

Ortus Sponsors

BoxLang is a professional open-source project and it is completely funded by the community and Ortus Solutions, Corp. Ortus Patreons get many benefits like a cfcasts account, a FORGEBOX Pro account and so much more. If you are interested in becoming a sponsor, please visit our patronage page: https://patreon.com/ortussolutions