Skip to content

ekospt/canvas

 
 

Repository files navigation



Introduction

A Laravel publishing platform. Canvas is a fully open source package to extend your 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!

Installation

Note: Canvas requires you to have user authentication in place prior to installation. You may run the make:auth Artisan command to satisfy this requirement.

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

composer require cnvs/canvas

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

php artisan canvas:install

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

php artisan storage:link

Configuration

Note: You are not required to complete the following steps. You have total design freedom when integrating blog content into your application.

Generate a default blog controller with routes and views to get up and running as quickly as possible:

php artisan canvas:setup

If you want to include Unsplash images in your posts, set up a new application at https://unsplash.com/oauth/applications. Grab your access key and update config/canvas.php:

'unsplash' => [
    'access_key' => env('CANVAS_UNSPLASH_ACCESS_KEY'),
],

Updates

You may update your Canvas installation using composer:

composer update

Run any new migrations using the migrate Artisan command:

php artisan migrate

You may also want to run this command to re-publish the assets:

php artisan vendor:publish --tag=canvas-assets --force

Testing

Run the tests with:

composer test

License

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

About

A Laravel publishing platform

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 73.4%
  • Vue 26.6%