brainsum / c2bdistro-project
Template for creating c2bdistro project via composer.
Installs: 11
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 4
Forks: 0
Open Issues: 0
Type:project
Requires
- php: >=8.1
- drupal/core-project-message: ^10.1.0-alpha1
Requires (Dev)
- roave/security-advisories: dev-master
This package is auto-updated.
Last update: 2024-11-03 09:59:15 UTC
README
Composer template to kickstart C2 projects.
This template was based on the following:
Installation
Note: These commands have been tested on linux (ubuntu), they might need changes to work on other systems. Note: In the host needs to be composer and min requirement for docker-compose version is 1.27.4.
Native composer
For the latest release:
composer create-project brainsum/c2bdistro-project my-c2bdistro-project
For a dev release:
composer create-project brainsum/c2bdistro-project --stability=dev my-c2bdistro-project
Setup
App
Drupal itself is in the app
folder, you need to use composer install
there, too.
Note, when using the supplied docker stack, on app
is mounted in the container.
Environment variables
By default, the project depends on some environment variables. See the settings.php scaffold file as well the files in the settings folder.
(Optional) Docker-compose
If you want to use docker-compose for development, you should copy example.env
as .env
, e.g cp example.env .env
. Update its contents as required.
For starting and stopping the environment you can use the helper scripts provided with the project (startup.sh
and shutdown.sh
). These also look for a docker-compose.local.yml
file so you can version control a generic config file and do local overrides (e.g ports, mounts).
Drush
To be able to make a db backup:
Copy app/drush/local/example.drush.yml
as app/drush/local/drush.yml
. Update its contents as required.
Filesystem permission fixes
E.g. on linux, you must fix file and directory permissions as well, e.g for "private_files", "web/sites/default/files", "tmp", ...
Install
Use drush site-install --account-pass=somestrongpass --site-mail=mail@currentsite.com --site-name=c2bdistro c2bdistro -y
You also might want to add --account-name
and --account-mail
.
Usage
Main site
Upload your assets and that's it. You can download them, images can be styled for social media purposes, logo can be added, etc.
API
The JSON:API module has been enabled, so you can serve your assets through that. An example would be using the FileField Sources JSON API module that allows you to configure file fields to allow downloading files from c2bdistro directly via the API.
Development
For development info see the DEVELOPMENT.md file.