Skip to content

Latest commit

 

History

History
64 lines (48 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

64 lines (48 loc) · 1.83 KB

Contributing to Azuriom

Code style

Azuriom follows the PSR-12 coding style.

Laravel Pint is included in the Composer dev-dependencies, and can be used to automatically fix code style issues with this command:

./vendor/bin/pint

Manual installation for development

  1. Clone the GitHub repository.

    git clone https://github.com/Azuriom/Azuriom.git
    
  2. Copy the .env.example file to .env and specify the database connection information.

  3. Set write/read permissions to the storage/, bootstrap/cache/, resources/themes/ and plugins/ folders:

    chmod -R 755 storage bootstrap/cache resources/themes plugins
    
  4. Install the PHP dependencies with Composer:

    composer install
    
  5. Install the front-end dependencies with NPM:

    npm install && npm run dev
    
  6. Generate the secret key:

    php artisan key:generate
    
  7. Setup the database:

    php artisan migrate --seed
    
  8. Create the storage symlink

    php artisan storage:link
    
  9. Create an admin account (Optional but recommended):

    php artisan user:create --admin
    
  10. Configure your web server to point to the public/ folder (Optional but recommended).

  11. Setup the scheduler (Optional but recommended):

    Some features need the scheduler to be set up, for this you need to configure your server to run the command php artisan schedule:run every minute, for example by adding this Cron entry (don't forget to replace /var/www/azuriom with the location of the site):

    * * * * * cd /var/www/azuriom && php artisan schedule:run >> /dev/null 2>&1