README.md

Cookiecutter farmOS Module

Powered by Cookiecutter, Cookiecutter farmOS Contrib Module is intended to be used by farmOS developers to create contrib modules.

Getting Started 🏁

Prerequisites

• pipx: A handy tool for installing and running Python applications.

Installation Guide 🛠️

1. pipx

pip install pipx

Generate Your farmOS Contrib Module 🎉

pipx run cookiecutter gh:fosten/cookiecutter-farmOS

Then select the farmOS Contrib Module template.

Project Generation Options

These are all the template options that will be prompted by the Cookiecutter CLI before generating your project.

Option	Description	Example
project_title	Your modules's human-readable name, capitals and spaces allowed.	farmOS module
description	Describes your addon and gets used in places like README.md and such.	An awesome farmOS module.
project_slug	Your project's slug without spaces. Used to name your repository and Docker images.	farmos-module
author	This is you! The value goes into places like LICENSE, setup.py and such.	Our Company
email	The email address you want to identify yourself in the project.	email@example.com
github_organization	Used for GitHub and Docker repositories.	farmOS

Code Quality Assurance 🧐

Your package comes equipped with PHP CodeSniffer and PHPUnit tests to ensure code quality. Trigger the GitHub Action workflows automatically format your code.

License 📜

This project is licensed under the MIT License.

Let's Get Building! 🚀

Happy coding!