File Structure

Building a proper module in web2project requires a handful of key files in a particular structure. Each of which serve a specific purpose in the operation of the system. For a module called Todos - available from the web2project Modules - we would have the following file structure (filenames are case sensitive):

Filename Status Description Notes
README.md required Module Details Information about the module, its release history, etc
/todos/ required folder Base folder of the module
/todos/setup.php required Setup Instructions Defines the details of the module along with install/uninstall directions
/todos/todos.class.php required Primary Model Defines all the business logic and CRUD operations for the module
/todos/index.php required List View Normally shows a list of any top-level items
/todos/index.js optional   Javascript that gets included in the Index layout
/todos/addedit.php optional Add/Edit View View that provides a form to add or edit the item
/todos/addedit.js optional   Javascript that gets included in the Add/Edit layout
/todos/view.php optional Item View View that provides a page to view the item
/todos/view.js optional   Javascript that gets included in the view layout
/todos/do_todos_aed.php optional Primary Controller Acts as the Controller/Dispatcher for most of the primary actions
/todos/companies_tab.view.todolist.php optional Subview Provides a embedded tab subview on the Company View page