Download the PHP package brokerexchange/showcase without Composer

On this page you can find all versions of the php package brokerexchange/showcase. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package showcase

Showcase

A Laravel package which adds the ability to create "showcases", or view boxes which contain cards "trophies" of items. It also includes an admin panel to manage displays and trophies, which can only be accessed by a logged-in Auth user. Intended for use by Laravel 5.4+

Still being developed!

Projects:

Installation

Install the package

To include the assets, you have two options:

  1. @import "vendor/brokerexchange/showcase/resources/assets/build/public"; in your main stylesheet, which will include the styles as part of your app's compiled styles.

  2. php artisan vendor:publish --tag=showcase-assets and link to /vendor/showcase/public.css in the <head>.

If you want to publish all the assets:

If you only want to publish specific pieces:

TODO: Finish this section and fix things so you don't have to use public/vendor

Install the package development environment

Test Project

To create a test project: bash build-test-project.sh

This can also be used to rebuild the test project if you messed something up.

If you want to use a different DB, change the credentials at the top of build-test-project.sh to match your desired credentials.

Update

To update the test project with package changes: bash update-test-project.sh

This will also dump composer's autoload and clear the Laravel cache and compiled views.

Flags you can use:

Authentication

The test project generates Auth during the build. A default user is created with the test project:

email: [email protected]
password: secret

You will need this to access the Showcase admin panels, as they are secured behind the Auth middleware by default. This can be changed from the config file.

Assets

To build the package JS and SCSS assets during development, just use the --rundev flag when running the update script. It will take care of compiling your assets and moving them to the proper locations in the test project.

You will still need to add a link for the showcase stylesheets to the test project head, as outlined in the package install instructions.


Use

Showcase is designed to be as simple to use as possible.

Displays

Using displays on your frontend is easy. First, get a display and pass it into the view:

To use it in the view, simply use the @showcaseDisplay() directive:

The display's template will be rendered automatically.

Trophies

If you look in the default display component views, you'll notice that they each call showcaseTrophy($trophy, $display). This directive renders a trophy component view, which renders a trophy's component view (or the display's default trophy component view, if force_trophy_default is set to true).

Both display and trophy component views can be customized.

Note: Currently, there is no "sort" functionality, but you can still sort trophies within a display by detaching/attaching trophies from a display, which will put a particular trophy last in the sorting order. This is for alpha functionality only, and proper sorting will be in place for 1.0


End User Customization

Display Components

After you've installed the package, you can use php artisan vendor:publish --tag=showcase to publish the package resources.

Modify Existing Views

Once the resources are published, you can find them in the resources/views/vendor/showcase directory. You can modify any of the package views, including the admin panels.

Add Custom Display Component

If you want to add a custom component, just create a new file in resources/views/vendor/showcase/public/components. Then, when creating or editing a display, your custom component will show up in the dropdown selection!

Custom CSS

Just target the Showcase selectors with your CSS to customize the styling. To make the custom styling show up on the admin panels, make sure you add a link tag for your CSS to the _stylesheets include in resources/views/vendor/showcase/app/includes.

Configuration

There are some configuration options exposed for you in the config file showcase.php.

Table Prefix

By default, all showcase tables are prefixed with showcase_. You may change this to whatever you desire.

Middleware

By default, all admin routes for Showcase are passed through web and auth. You may change this array in config to add or remove middleware as you want.


All versions of showcase with dependencies

PHP Build Version
Package Version
Requires laracasts/flash Version ^3.0
illuminate/database Version ^5.4
fzaninotto/faker Version ^1.4
illuminate/filesystem Version ^5.4
illuminate/pagination Version ^5.4
nesbot/carbon Version ^1.27
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package brokerexchange/showcase contains the following files

Loading the files please wait ....