Create a Module

Learn how to create custom modules for Oqtane to extend its functionality and add new features to your applications.

Overview

Creating a module in Oqtane involves several steps, including setting up the project, defining module components, implementing functionality, and testing the module in different environments.

Getting Started

To create a module for Oqtane, follow these steps:

1. Use the Oqtane Administration Dashboard > Module Management Create Module button to scaffold a new module project.
2. Navigate to the project which will be located in the root folder of the Oqtane.Framework folder.
3. Open the solution file in another instance of Visual Studio and build the project.
4. Restart your Oqtane.Server Visual Studio application used to create the module.
5. Implement module components, including views, services, and controllers.
6. Define module configuration settings and permissions.
7. Test the module locally to ensure that it behaves as expected.
8. Package the module for distribution and installation on other Oqtane sites.

Development Process

The module development process typically involves:

• Project setup and configuration
• Component implementation and integration
• Testing and debugging
• Documentation and packaging

Best Practices

• Follow the Oqtane module development guidelines and coding standards.
• Use dependency injection for managing dependencies and promoting modularity.
• Utilize Oqtane services and APIs for interacting with the platform and accessing data.
• Test your module in different environments to ensure compatibility and stability.

---

Main Author

Cody, @thabaum [Oqtane Core Team]

Passionate about Oqtane!

Github: @thabaum