README

Y USA Open YMCA

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

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

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

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.

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 allows you to make a contribution into OpenY in a few minutes. Just follow steps and then you'll know how to do it.

Docksal is a tool for defining and managing development environments.

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

Add your repository to composer.json

"repositories": [
    {
        "type": "vcs",
        "url": "https://github.com/GITHUB_USERNAME/yusaopeny"
    }
]

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",
}
```
Run composer update to update packages
Add and commits changes in docroot/profiles/contrib/openy. Now it should be pointed to your fork.

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 about Open Y is available at ds-docs.y.org. For details please visit https://ycloud.y.org/open-y-association-websites.

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