Redmine Plugin Boilerplate

Overview

redmine_plugin_boilerplate is a template repository designed to simplify the process of creating Redmine plugins. It is available on GitHub in a template format, making it easy for developers to kickstart their Redmine plugin projects.

Features

• Easy Plugin Creation: Simplifies the creation of Redmine plugins.
• Template Repository: Available as a template repository on GitHub.
• Codespaces Integration: Use Github Codespaces for development, enabling development from anywhere with just a web browser.
• Flexible Environment: Customize Redmine version, Ruby version, and database type combinations according to your project requirements.
• Debugger Support: Utilize debuggers for efficient debugging.

Getting Started

To create a new Redmine plugin using redmine_plugin_boilerplate, follow these steps:

1. Open the redmine_plugin_boilerplate repository on Github.
2. Click the Use this template button to create a new repository for your plugin. Ensure to name the repository after your desired plugin name.
3. Create a Github Codespace for your new repository.
4. Once the Codespace is ready, open .devcontainer/redmine.code-workspace and apply it.
5. When the workspace is open, launch the Terminal.
6. In the Terminal, execute the following command: sh .devcontainer/plugin_generator.sh
7. This will generate the basic structure for your plugin.
8. Customize and edit the generated files to develop your plugin.
9. Replace the content of this Readme.md file with information specific to your plugin.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Feel free to customize and expand upon the generated template to meet the specific requirements of your Redmine plugin.

Happy coding!