octobro/oc-boilerplate

OctoberCMS Boilerplate

by Octobro, _(*1)

OctoberCMS is a powerful CMS based on Laravel PHP Framework., _(*2)

Requirements

1. PHP >= 7.4
2. Composer 2
3. October CMS License Key (auth.json)

Getting Started

1. Clone to your base project directory., _(*3)

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

2. Go to the project folder and don't forget to remove .git folder. Create your own repository., _(*4)

   cd <project-name>
   rm -rf ./.git
   git init
   

3. Put the auth.json to the root directory for your access to download the October CMS library. Don't forget to remove it from .gitignore if you already set up the project., _(*5)

4. Install composer dependencies., _(*6)

   composer install
   

5. Create configuration file .env (copy from .env.example) and set the database configuration., _(*7)

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

6. Migrate October database., _(*8)

   php artisan october:migrate
   

7. For security reason, please generate new application key., _(*9)

   php artisan key:generate
   

8. To enable Laravel Horizon, run the command below to generate the assets., _(*10)

   php artisan horizon:assets
   

Plugins

In this boilerplate, we've installed:, _(*11)

1. RainLab.User
2. RainLab.Sitemap
3. RainLab.Pages
4. Mja.Mail
5. Jacob.Horizon

More plugins that we recommend (not installed yet):, _(*12)

1. RainLab.Blog
2. RainLab.Translate
3. Responsiv.Uploader

To install plugin, run the command:, _(*13)

php artisan plugin:install <plugin-name>

Frontend Theme

We implement the minimalist CSS library Pico.css., _(*14)

Coding Standards

Please follow the following guide:, _(*15)

• OctoberCMS Developer Guide