Download the PHP package presentator/starter without Composer

On this page you can find all versions of the php package presentator/starter. 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?

Example code of presentator/starter

Informations about the package starter

Presentator Starter

[!IMPORTANT] This repo is for the older Presentator v2 and it is no longer maintained.

Presentator Starter is a skeleton Presentator v2 installation setup best suited for production environment.

It wraps all required components for a Presentator installation in a single package and allows seamless upgrades just by using Composer.

This repository is READ-ONLY. Report issues and send pull requests in the main Presentator repository.

If you prefer a dockerized version of the starter package, please check presentator-docker.

Requirements

Installation

  1. Install through Composer:

    For security reasons, if you are using a shared hosting service it is recommended to place the project files outside from your default public_html(www) directory!

  2. Setup a vhost/server address (eg. https://your-presentator.com/) and point it to /path/to/starter/web/.

    By default a generic .htaccess file will be created for you after initialization. If you are using Nginx, you could check the following sample configuration.

  3. Create a new database (with utf8mb4_unicode_ci collation).

  4. Adjust the db, mailer and other components configuration in config/base-local.php accordingly.

    Check base.php for all available options.

  5. Adjust your environment specific parameters (public urls, support email, etc.) in config/params-local.php accordingly.

    Check params.php for all available options.

  6. (optional) If needed, you could also adjust the frontend (aka. SPA) settings by editing the extra.starter.spaConfig key in your composer.json file.

    Check .env for all available options.

  7. Run composer install to make sure that the application is properly inited.

  8. (optional) Setup a cron task to process unread screen comments:

That’s it! Check the application in your browser to verify that everything is working fine.

Additional console commands you may find useful

Allow 3rd party authentication (OAuth2)

The default base-local.php comes with commented various auth clients configurations.

For example, if you want to allow your users to login with their Facebook account:

  1. Register a Facebook app (only the account email is required, so there is no need for any special permissions).

    Make sure for Valid OAuth Redirect URIs to set the same url as authClientRedirectUri from your params-local.php (by default it should be something like https://your-presentator.com/#/auth-callback).

    NB! Some clients may not support hash/fragment URIs (aka. /#/). In this case, define your redirect uri without the hash (eg. https://your-presentator.com/auth-callback) and add a redirect/rewrite rule to your Nginx/Apache configuration that should prepend /#/ to the request path address. Here is a generic Nginx redirect rule:

  2. Register the Facebook auth client in your base-local.php:

Different storage mechanism

By default all uploaded files are stored locally on your server in /path/to/starter/web/storage. If you are worried about disk space or want to store your uploads on a different server, you could override the default fs component configuration.

For example, if you want to store your files on AWS S3:

  1. Update the baseStorageUrl in your params-local.php

  2. Add the AWS S3 filesystem adapter to your dependencies

  3. Override the default fs component in your base-local.php:

    You may also want to check #138 and #141.

For other adapters and more options, go to https://github.com/creocoder/yii2-flysystem.

Update

To update your Presentator application to the latest available version, just run composer update while in the project root directory.

For a finer control, check the packages version constraint in the require section of /path/to/starter/composer.json.

Backup & Restore

To backup your Presentator application:

  1. Export your Presentator database via the DBMS cli tools (eg. mysqldump, pg_dump) or via Adminer/phpMyAdmin/etc.

  2. Backup the app config/ folder and the uploaded users content (usually web/storage/).

To restore your Presentator application you can apply the following steps for an old or new installation:

  1. Import your Presentator database via the DBMS cli tools (eg. mysqldump, pg_dump) or via Adminer/phpMyAdmin/etc.

  2. Return the previously backuped config/ and uploaded users content to their original location.

  3. Run php /path/to/starter/yii migrate up to ensure that the latest app database changes are applied.

All versions of starter with dependencies

PHP Build Version
Package Version
Requires presentator/api Version ^2.15.1
presentator/spa Version ^2.15.1
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 presentator/starter contains the following files

Loading the files please wait ....