2017 © Pedro Peláez
 

project openy-project

Project template for OpenY projects with composer

image

ymcatwincities/openy-project

Project template for OpenY projects with composer

  • Thursday, May 31, 2018
  • by sanchiz
  • Repository
  • 7 Watchers
  • 1 Stars
  • 7,276 Installations
  • Shell
  • 0 Dependents
  • 0 Suggesters
  • 23 Forks
  • 3 Open issues
  • 12 Versions
  • 12 % Grown

The README.md

react-router , (*1)

Y USA Open YMCA

https://ycloud.y.org/open-y-association-websites , (*2)

An open source platform for YMCAs, by YMCAs built on Drupal. , (*3)

, (*4)

The Y USA Open Y Project is a composer based installer for the Y USA Open Y distribution., (*5)

Requirements

Composer

If you do not have Composer, you may install it by following the official instructions. For usage, see the documentation., (*6)

Installation

Latest STABLE version

composer create-project ymcatwincities/openy-project MY_PROJECT --no-interaction
cd MY_PROJECT

Latest DEVELOPMENT version (Drupal 9 2.x)

composer create-project ycloudyusa/yusaopeny-project:9.2.x-development-dev MY_PROJECT --no-interaction --no-dev
cd MY_PROJECT

This command will build project based on the Drupal 9 development branch release., (*7)

See https://youtu.be/jRlinjpTl0c how to video for the whole process of this command usage., (*8)

Development environment

You should use composer command without --no-dev if you would like to get environment that was configured especially for OpenY. This means you'd remove Vagrant/Docksal from the code tree. So it should look like this:, (*9)

composer create-project ycloudyusa/yusaopeny-project:9.2.x-development-dev MY_PROJECT --no-interaction
cd MY_PROJECT

See https://youtu.be/jRlinjpTl0c how to video for the whole process of this command usage.

CIBox VM

CIBox VM allows you to make a contribution into OpenY in a few minutes. Just follow steps and then you'll know how to do it., (*10)

Read more details on CIBox VM repo., (*11)

Docksal

Docksal is a tool for defining and managing development environments., (*12)

Read more details on Docksal repo., (*13)

Use Fork for the development

All development happens in the Open Y Drupal 9 installation profile. In order to start development:, (*14)

  1. Create fork of Open Y installation profile
  2. Add your repository to composer.json 
"repositories": [
    {
        "type": "vcs",
        "url": "https://github.com/GITHUB_USERNAME/yusaopeny"
    }
]
  1. Change a version for ycloudyusa/yusaopeny to dev-9.x-2.x or any other branch. E.g.:

- branch name "bugfix" - version name dev-bugfix - branch name "feature/workflow" - version name dev-feature/workflow, (*15)

"require": {
    "ycloudyusa/yusaopeny": "dev-9.x-2.x",
}

"require": {
    "ycloudyusa/yusaopeny": "dev-feature/workflow",
}
  1. Run composer update to update packages
  2. Add and commits changes in docroot/profiles/contrib/openy. Now it should be pointed to your fork.

Directory structure

Directory Purpose
Y USA Open Y
docroot/ Contains Drupal core
docroot/profiles/contrib/openy/ Contains Open Y distribution
vendor/ Contains Y USA Open Y distribution
composer.json Contains Y USA Open Y distribution
CIBox VM + CIBox Build
cibox/ Contains CIBox libraries
docroot/devops/ DevOps scripts for the installation process
provisioning/ Vagrant configuration
docroot/*.sh Bash scripts to trigger reinstall scripts
docroot/*.yml YAML playbooks for the installation process
Vagrantfile Vagrant index file
Docksal
.docksal/ Docksal configuration
build.sh Build script for Docksal environment

Documentation

Documentation about Open Y is available at docs. For details please visit https://ycloud.y.org/open-y-association-websites., (*16)

License

Y USA OpenY Project is licensed under the GPL-3.0. See the License file for details., (*17)

The Versions

31/05 2018

8.1.x-dev

8.1.9999999.9999999-dev

Project template for OpenY projects with composer

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

24/05 2018

dev-8.1.x-development

dev-8.1.x-development

Project template for OpenY projects with composer

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

09/05 2018

1.0.7

1.0.7.0

Project template for OpenY projects with composer

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

28/03 2018

1.0.6

1.0.6.0

Project template for OpenY projects with composer

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

28/03 2018

1.0.5

1.0.5.0

Project template for OpenY projects with composer

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

11/12 2017

1.0.4

1.0.4.0

Project template for OpenY projects with composer

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

18/09 2017

1.0.3

1.0.3.0

Project template for OpenY projects with composer

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

01/06 2017

1.0.2

1.0.2.0

Project template for OpenY projects with composer

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

25/05 2017

1.0.1

1.0.1.0

Project template for OpenY projects with composer

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

28/04 2017

1.0.0

1.0.0.0

Project template for OpenY projects with composer

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

27/03 2017

dev-8.1.x-development-cibox

dev-8.1.x-development-cibox

Project template for OpenY projects with composer

  Sources   Download

GPL-2.0+

The Requires

 

The Development Requires

15/03 2017

dev-8.1.x-development-docksal

dev-8.1.x-development-docksal

Project template for OpenY projects with composer

  Sources   Download

GPL-2.0+

The Requires