Download the PHP package charcoal/boilerplate without Composer

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

Informations about the package boilerplate

Charcoal Project Boilerplate

A skeleton for creating Web sites with Charcoal.

See below for an overview of this skeleton's structure and objectives.

Installation

This skeleton is available on Packagist and can be installed using Composer:

After the skeleton is installed, point the document root of your Web server to the example-project/www directory.

By default, the skeleton includes an Apache .htaccess file. See below for examples on configuring your Web server.

From the command line, PHP provides a built-in Web server for quickly serving your project:

Visit http://localhost:8080 in your browser to see the following:

Example: Skeleton's default index page ![Screen capture of the skeleton's unstyled index page](docs/images/boilerplate-home.png)

Update

The skeleton does not provide any process for automated upgrades. You will have to port any updates manually.

This is because the skeleton is a starting point for your project and its various files are mainly present for demonstration and would otherwise be removed or modified for your purposes.

Application Configuration

Create a copy of the config/config.sample.json file and name it config/config.local.json. This is your environment specific configuration file and it should be excluded from your project's source control repository. Edit this file to configure services such as the database, third-party services, logs, and caches.

Any other options relevant to your project should be changed in all other files in the config directory.

Database Configuration

If your project does not require any database storage, use a database in-memory such as SQLite by adding the following to the config/config.local.json file:

If your project uses MySQL, create an empty database and ensure a SQL user has the proper permissions for this database. Then add the following to the config/config.local.json file:

Project Name

By default, the skeleton uses "Acme" as a dummy name. There are a few occurrences throughout the repository that should be changed to reflect your project:

You should also change the details of the Composer dependency manifest:

Administration Dashboard

A quick-and-dirty command line script is provided to install the assets for the administration area:

Afterwards, visit http://localhost:8080/admin/login in your browser to see the following:

Example: Charcoal's administration login page ![Screen capture of Charcoal's administration login page](docs/images/admin-login.png)

The administration area can be customized from the config/admin.json file.

Install Locomotive Boilerplate

Optionally, another quick-and-dirty script is provided to install the Locomotive's front-end development tools:

For more information, visit Locomotive's Boilerplate repository.

Server Requirements

Server Configuration

Apache Configuration

Use the following configuration as a starting point for configuring the Apache HTTP server. Note that this should be used instead of the skeleton's .htaccess file.

Note that you should replace path/to/example-project/www with the actual path for example-project/www.

Example: Apache configuration

Nginx Configuration

Use the following configuration as a starting point for configuring the Nginx HTTP server.

Note that you should replace path/to/example-project/www with the actual path for example-project/www.

Example: Nginx configuration

Development

Linting

By default, the skeleton is developed with a number of coding style and static code analysis tools:

PHPStan and Psalm are used together to take advantage of each one's specialties.

Linting can be executing by running one of the following commands:

Most of these tools can be configured from the following files:

Testing

By default, PHP tests are located in the tests directory and developed with the PHPUnit framework.

Tests can be executing by running one of the following commands:

PHPUnit can be configured from the phpunit.xml.dist or a local phpunit.xml file.

Optimization

Locked Dependencies

Your project's dependencies can be installed considerably faster when you include the composer.lock file in your project's source control repository. Composer automatically generates and keeps this file up to date.

Autoloader Optimization

When deploying to production, ensure that you are optimizing Composer's class autoloader map so Composer can rapidly find the corresponding file for a given PHP class:

Contributing

We appreciate any contribution to the skeleton and Charcoal, whether it's a bug, typo, suggestions, or improvements.

Overview

Although it is ready to use, this skeleton is still incomplete.

It does not yet showcase all of the features of the Charcoal framework and therefore requires a lot of manual tinkering for options.

The following is a short "mission statement" of what is expected to be accomplished with this skeleton:

🚂

All versions of boilerplate with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0
charcoal/charcoal Version ^5.0
mustache/mustache Version ^2.14
twig/twig Version ^3.4
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 charcoal/boilerplate contains the following files

Loading the files please wait ....