Download the PHP package mtconsultingroup/canvas-portfolio without Composer

Introduction

Canvas is a fully open source package to extend your existing Laravel application and get you up-and-running with a blog in just a few minutes. In addition to a distraction-free writing experience, you can view monthly trends on your content, get insights into reader traffic and more!

Table of Contents

• System Requirements
• Installation
• Configuration
• Roles & Permissions
• Features
• Updates
• Contributing
• License

System Requirements

• PHP >= 7.3
• Laravel >= 6.0
• One of the four supported databases by Laravel

Installation

You may use composer to install Canvas into your Laravel project:

Publish the assets and primary configuration file using the canvas:install Artisan command:

Create a symbolic link to ensure file uploads are publicly accessible from the web using the storage:link Artisan command:

Configuration

After publishing Canvas's assets, a primary configuration file will be located at config/canvas.php. This file allows you to customize various aspects of how your application uses the package.

Canvas exposes its UI at /canvas by default. This can be changed by updating either the path or domain option:

Sometimes, you may want to apply custom roles or permissions when accessing Canvas. You can create and attach any additional middleware here:

Canvas uses the storage disk for media uploads. You may configure the different filesystem options here:

Roles & Permissions

Canvas has 3 pre-defined roles:

• Contributor (Somebody who can write and manage their own posts but cannot publish them)
• Editor (Somebody who can publish and manage posts including the posts of other users)
• Admin (Somebody who can do everything and see everything)

When you install a fresh version of Canvas, you'll have a default admin user set up automatically. From there, you can perform any basic CRUD actions on users, as well as assign their various roles.

Features

Note: The following features are completely optional, you are not required to use them.

Frontend

Use the canvas:ui Artisan command to get the frontend APIs:

Unsplash Integration

Want access to the entire Unsplash library? Set up a new application at https://unsplash.com/oauth/applications, grab your access key, and update config/canvas.php:

Weekly Digest

Want a weekly summary? Canvas allows users to receive a weekly summary of their authored content. Once your application is configured for sending mail, update config/canvas.php:

Since the weekly digest runs on Laravel's Scheduler, you'll need to add the following cron entry to your server:

Portfolio

Want a portfolio integration?

Multiple languages

You can also edit your contents in multiple languages

Automatic translation

Updates

Canvas follows Semantic Versioning and increments versions as MAJOR.MINOR.PATCH numbers.

• Major versions will contain breaking changes, so follow the upgrade guide for a step-by-step breakdown
• Minor and patch versions should never contain breaking changes, so you can safely update the package by following the steps below:

You may update your Canvas installation using composer:

Run any new migrations using the canvas:migrate Artisan command:

Re-publish the assets using the canvas:publish Artisan command:

To keep the assets up-to-date and avoid issues in future updates, you may add the canvas:publish command to the post-update-cmd scripts in your application's composer.json file:

Contributing

Thank you for considering contributing to Canvas!

You can use the contribution guide to assist you in manually setting up an environment on your own machine.

License

Canvas is open-sourced software licensed under the MIT license.