Download the PHP package dnadesign/basic-recipe without Composer

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

Codeship Status for dnadesign/dna-recipe

Dna Recipe

Includes a collection of useful modules, a starter theme, and the silverstripe recipe-cms

Requirements

Silverstripe 4. See 3.0 branch for silverstripe 3 support.

Getting started

NOTE: assumes you have node setup and gulp installed globally. If not, you should go do those things first

Install

To start a project with this recipe use a terminal to run (replace your-project with your project's name):

composer create-project dnadesign/basic-recipe ./your-project cd your-project
make setup

This will:

Recipe options

To add this recipe to an existing project:

(optional) composer require dnadesign/basic-recipe ./your-project

To move the cms recipe dependencies to your own composer file in order to modify them:

(optional) composer update-recipe silverstripe/recipe-cms

More information about recipes and how to work with them is available here: https://github.com/silverstripe/recipe-plugin

Using this recipe

This code comes bundled with a makefile for quick access to common tasks. Run make list or make help to get a list of available options, or open the Makefile directly.

Theme

Theme-default is a starter theme, intended to be used as a base for development. See the theme README file for theme specific documentation

Testing and deployment

This recipe comes with setup for a deployment pipeline from CodeShip to Silverstripe Dashboards. There are commands in the MakeFile for this purpose.

If you don't intend to use this pipeline, feel free to remove these from the makefile. Note that by default we aren't committing built assets, so if you have a git based deployment pipeline, you might want to remove theme-default/dist from .gitignore

Prerequisites

Note: you can still use Codeship and not deploy to platform.

Setup

  1. Update the pipeline_project_name in the MakeFile with the project name used in the Silverstripe Dashboard.
  2. Codeship: create a new project for this build, and set it up with your projects git details (Codeship supports GitHub, GitLab, and BitBucket repos)

CodeShip: Setup your tests

Codeship > Your project > Project settings > Test

Setup commands
  1. Select your technology > select php
  2. Update the php version to support your project. eg: phpenv local 7.2
  3. Adjust any other settings you might need (e.g. you can set memory limits with: echo "memory_limit = 512M" >> $HOME/.phpenv/versions/7.2/etc/php.ini )
  4. Call make pipeline_setuptest to set up an instance of your project for tests to run inside
Configure Test Pipelines
  1. Create a test pipeline
  2. Call the make pipeline_test command to run all your project's tests

Note: Tests can be bypassed if the most recent commit message contains SKIP_CI. eg: FIX: response.js bug by updating [SKIP_CI]

Codeship: setup for deployments

Configuration

Configure your Codeship environment variables under Project settings > Environment. You will need:
AWS_DEFAULT_REGION - from your s3 bucket account. e.g. ap-southeast-2
AWS_ACCESS_KEY_ID - from your s3 bucket account.
AWS_SECRET_ACCESS_KEY - from your s3 bucket account.
DASHBOARD_TOKEN - You can find this in your profile on the Silverstripe Dashboard
DASHBOARD_USER - this is the email address you use on the dashboard, and not your username

Note: The AWS connections might be adapted for deployments to other environments, if you aren't hosted on CWP, or the Silverstripe Platform.

Deployment

Project settings > Deploy

  1. Add a new deployment pipeline, and choose a deployment branch
  2. Choose "Custom script"
  3. Call make pipeline_deploy. This will prep the test build - removing unwanted files, create a tar file, and send it to a SilverStripe Dashboard for deployment.

You should now be able to push to your deployment branch to trigger a deploy

All versions of basic-recipe with dependencies

PHP Build Version
Package Version
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 dnadesign/basic-recipe contains the following files

Loading the files please wait ....