Installation

Summary (WIP)

Publishing migrations

Migrations should be published in the following order:

1. core-migrations
2. data-profiling-migrations
3. crm-migrations
4. financial-migrations
5. ecommerce-migrations

Use the following command to ensure the right order:
Packages that are not installed are skipped.

php artisan vendor:publish --tag=core-migrations && php artisan vendor:publish --tag=data-profiling-migrations && php artisan vendor:publish --tag=crm-migrations && php artisan vendor:publish --tag=financial-migrations && php artisan vendor:publish --tag=ecommerce-migrations

Running the seeders

Most projects contain a seeder called CompassSeeder. The seeders provided by compass package should allows be allowed to run to add new menu items, permissions and necessary data for new functionality.

Normally the CompassSeeder is also called in the deployment script of the application in Laravel Forge. If that isn't the case, it should be added to ensure full compass functionality.

Compass Seeders should be run in the following order:

1. CoreSeeder
2. DataProfilingSeeder
3. CrmSeeder
4. FinancialSeeder
5. EcommerceSeeder
6. Your custom project permissions, menu items seeder
7. Additional seeders provided by the project for functionality that's always allowed to run.

NPM assets

To make use of the sass and js files provided by the compass packages, the following steps need to be taken:

1. For each package, this time including supporting packages, the path should be included in the package.json file.
   Package.json dependencies example (Only add the packages your project uses):

   "dependencies": {
       "@noardcode/compass-core": "file:vendor/noardcode/compass-core",
       "@noardcode/compass-side-panels": "file:vendor/noardcode/compass-side-panels",
       "@noardcode/compass-tables": "file:vendor/noardcode/compass-tables",
       "@noardcode/compass-forms": "file:vendor/noardcode/compass-forms",        
   }    

2. Run npm install to install the npm packages.
3. Include the compass assets in the sass and js files of your project. These files are probably in the resources/sass/app.scss and resources/js/bootstrap.js files.
4. Run npm run prod to compile the new assets.

Example of the app.scss file:

@import '~@noardcode/compass-core';
@import '~@noardcode/compass-side-panels';
@import '~@noardcode/compass-tables';
@import '~@noardcode/compass-forms';

Example of the bootstrap.js file:

require('@noardcode/compass-core');
require('@noardcode/compass-side-panels');
require('@noardcode/compass-tables');
require('@noardcode/compass-forms');