ymcatwincities / openy-project
Project template for OpenY projects with composer
Installs: 28 042
Dependents: 0
Suggesters: 0
Security: 0
Stars: 8
Watchers: 9
Forks: 42
Open Issues: 16
Language:Shell
Type:project
Requires
- cweagans/composer-patches: ~1.0
- ymcatwincities/openy: ^9.2
Requires (Dev)
- consolidation/robo: ^1.1.5 || ^2
- drush/drush: ^10.5.0 || ^11
- ymcatwincities/openy-cibox-build: dev-solr6
- ymcatwincities/openy-cibox-vm: dev-master
- ymcatwincities/openy-docksal: dev-master
- 9.2.x-dev
- 8.2.x-dev
- 8.1.x-dev
- 2.4
- 2.3.0
- 2.2.2
- 2.2.1
- 2.2.0
- 2.1.3
- 2.1.2
- 2.1.1
- 2.1.0
- 2.0.15
- 2.0.14
- 2.0.13
- 2.0.12
- 2.0.11
- 2.0.10
- 2.0.9
- 2.0.8
- 2.0.7
- 2.0.6
- 2.0.5
- 2.0.4
- 2.0.3
- 2.0.2
- 2.0.1
- 2.0.0
- 1.0.10
- 1.0.9
- 1.0.8
- 1.0.7
- 1.0.6
- 1.0.5
- 1.0.4
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- dev-9.2.x-development
- dev-9.2.x-init
- dev-9.2.x-development-af4
- dev-openy_custom
- dev-init_vs_stable
- dev-podarok-patch-1
- dev-9.x-2.x-drupal_core9.2patch
- dev-9.2.x-core920
- dev-9.2.x-gxp
- dev-podarok/gitpod-setup
- dev-8.1.x-development
- dev-8.2.x-development
- dev-8.x-2.x-ubuntu20_php7.4
- dev-8.2.x-composer2
- dev-php_workflow
- dev-8.2.x-temp
- dev-8.2.x-virtual-y-latest
- dev-8.2.x-virtual-y
- dev-revert-79-8.2.x
- dev-revert-67-CIYMCA-142
- dev-test_ygtc_devops
This package is auto-updated.
Last update: 2022-07-08 08:58:59 UTC
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 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.
See https://youtu.be/jRlinjpTl0c how to video for the whole process of this command usage.
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:
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.
Read more details on CIBox VM repo.
Docksal
Docksal is a tool for defining and managing development environments.
Read more details on Docksal repo.
Use Fork for the development
All development happens in the Open Y Drupal 9 installation profile. In order to start development:
- Create fork of Open Y installation profile
- Add your repository to
composer.json
"repositories": [
{
"type": "vcs",
"url": "https://github.com/GITHUB_USERNAME/yusaopeny"
}
]
- Change a version for
ycloudyusa/yusaopeny
todev-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
"require": {
"ycloudyusa/yusaopeny": "dev-9.x-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 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.
License
Y USA OpenY Project is licensed under the GPL-3.0. See the License file for details.