https://github.com/timkelty/craftcms-appmodule
https://github.com/timkelty/craftcms-appmodule
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/timkelty/craftcms-appmodule
- Owner: timkelty
- License: mit
- Created: 2018-07-23T17:01:17.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-23T17:01:23.000Z (almost 8 years ago)
- Last Synced: 2025-04-11T23:37:12.836Z (about 1 year ago)
- Language: PHP
- Size: 16.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# AppModule module for Craft CMS 3.x
The app module.
## Requirements
This module requires Craft CMS 3.0.0-RC1 or later.
## Installation
To install the module, follow these instructions.
First, you'll need to add the contents of the `app.php` file to your `config/app.php` (or just copy it there if it does not exist). This ensures that your module will get loaded for each request. The file might look something like this:
```
return [
'modules' => [
'app-module' => [
'class' => \modules\appmodule\AppModule::class,
'components' => [
'appModuleService' => [
'class' => 'modules\appmodule\services\AppModuleService',
],
],
],
],
'bootstrap' => ['app-module'],
];
```
You'll also need to make sure that you add the following to your project's `composer.json` file so that Composer can find your module:
"autoload": {
"psr-4": {
"modules\\appmodule\\": "modules/appmodule/src/"
}
},
After you have added this, you will need to do:
composer dump-autoload
…from the project’s root directory, to rebuild the Composer autoload map. This will happen automatically any time you do a `composer install` or `composer update` as well.
## AppModule Overview
-Insert text here-
## Using AppModule
-Insert text here-
## AppModule Roadmap
Some things to do, and ideas for potential features:
* Release it
Brought to you by [Tim Kelty](http://fusionary.com)