README

Y USA Open YMCA

https://ycloud.y.org/open-y-association-websites

An open source platform for YMCAs, by YMCAs built on Drupal.

The Y USA Open Y Project is a composer based installer for the Y USA Open Y distribution.

Requirements

Composer

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

Installation

Latest STABLE version

composer create-project ycloudyusa/yusaopeny-project MY_PROJECT --no-interaction
cd MY_PROJECT

BETA version install

If you need to install beta, you should provide exact version to get it locally

Example:

composer create-project ycloudyusa/yusaopeny-project:^4.1.0@beta MY_BETA_PROJECT --no-interaction
cd MY_BETA_PROJECT

Latest DEVELOPMENT version (Drupal 10 2.x)

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

This command will build project based on the Drupal 10 development branch release.

See our how to video for the whole process of this command usage.

Development environments

You should use composer command without --no-dev if you would like to get environment that was configured especially for OpenY development.

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

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.

• Pre Requirements
• Installation
• Local build

Read more details on CIBox VM repo.

Docksal

Docksal is a tool for defining and managing development environments.

• How to develop
• How to run behat tests

Read more details on Docksal repo.

Use Fork for the development

All development happens in the YUSA Open Y Drupal 10 installation profile. In order to start development:

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"
       }
   ]
   

3. Change a version for ycloudyusa/yusaopeny to dev-10.2.x or any other branch. E.g.:

   • branch name "bugfix" - version name dev-bugfix
   • branch name "feature/workflow" - version name dev-feature/workflow

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

   "require": {
       "ycloudyusa/yusaopeny": "dev-feature/workflow",
   }
   

4. Run composer update to update packages

5. Add and commits changes in docroot/profiles/contrib/openy. Now it should be pointed to your fork.

Directory structure

Documentation

Documentation about Open Y is available at ds-docs.y.org. For details please visit https://ycloud.y.org/open-y-association-websites.

License

Y USA OpenY Project is licensed under the GPL-3.0. See the License file for details.