OctoberCMS Boilerplate

by Octobro

---

OctoberCMS is a powerful CMS based on Laravel PHP Framework.

Prerequisites

1. PHP > 7.1
2. MySQL or MariaDB
3. Composer
4. Yarn

Getting Started

1. Clone to your base project directory.

   git clone https://github.com/octobroid/oc-boilerplate.git <project-name>
   

2. Don't forget to remove .git folder, create your own repository.

   rm -rf !$/.git
   

3. Install composer dependencies.

   composer install
   

4. Create configuration file .env (copy from .env.example) and set the database configuration.

   DB_HOST=localhost
   DB_DATABASE=<database-name>
   DB_USERNAME=<database-user>
   DB_PASSWORD=<database-password>
   

5. Migrate October database.

   php artisan october:up
   

6. Install frontend library using Yarn. Go to theme directory first.

   cd themes/my-theme
   yarn install
   

7. For security reason, please generate new application key.

   php artisan key:generate
   

8. Create your own plugin

   php artisan create:plugin Foo.Bar
   

9. In your Foo.Bar Plugin.php file, add code bellow to configure lighthouse configruration

class Plugin extends PluginBase
{
	public function boot()
    {
        App::register('Nuwave\Lighthouse\LighthouseServiceProvider');
        App::register('MLL\GraphQLPlayground\GraphQLPlaygroundServiceProvider');
    }
}

10. Publish your lighthouse configuration with command php artisan vendor:publish and register the lighthouse configuration in config/lighthouse with following code. You can find schema.graphql in Plugins/Foo/Barr/Graphql/Schema.graphql

    'schema' => [
        'register' => base_path('plugins/foo/bar/graphql/schema.graphql'),
    ],

11. Open url {{your_domain}}/graphql-playground you can find schema configuration on this panel.

Plugins

In this boilerplate, we've installed:

1. RainLab.User
2. RainLab.Pages
3. RainLab.Sitemap
4. RainLab.GoogleAnalytics
5. October.Drivers
6. Bedard.Debugbar
7. Mja.Mail
8. Jacob.Horizon

More plugins that we recommend (not installed yet):

1. RainLab.Blog
2. RainLab.Translate
3. Responsiv.Uploader
4. eBussola.Feedback

To install plugin, run the command:

php artisan plugin:install <plugin-name>

To enable Laravel Horizon, run the command:

php artisan vendor:publish --provider="Laravel\Horizon\HorizonServiceProvider"

Frontend Libraries

All frontend libraries are managed using bower. These packages are installed by default:

1. Bootstrap
2. Font Awesome
3. FastClick

To install additional library, run the command:

yarn add <package-name>

Coding Standards

Please follow the following guide:

• OctoberCMS Developer Guide
• Lighthouse Developer Guide