imagex/openedu-project-docksal

Project template for Drupal 8 sites built with the OpenEDU distribution and Docksal.

Maintainers

Details

bitbucket.org/ixm/openedu-project-docksal

Homepage

Source

Installs: 62

Dependents: 0

Suggesters: 0

Security: 0

Type:project

8.3.0 2018-06-23 22:15 UTC

Requires

Requires (Dev)

GPL-2.0-or-later 49e0671c1e4536a4699f71ff5e9195975689ba56

This package is auto-updated.

Last update: 2023-05-24 09:32:23 UTC

README

This is a Composer-based installer for the OpenEDU Drupal distribution.

Docksal is used as a local development environment.

Get Started

1. One-time Docksal installation

You need to install Docksal on your local machine according to Docksal setup instructions.

2. Fetch the code

composer create-project imagex/openedu-project-docksal MY_PROJECT

Composer will create a new directory called MY_PROJECT containing a `docroot` directory with a full OpenEDU code base.

3. Initialize the project Enter the project's folder and run

fin init

The webserver starts up, and the site will be installed automatically.

Administrator account is admin:admin.

Helpful Tips

  • The `docroot` folder represents the web root for your site (the folder your web server points to).
  • Some helpful tools can be found in the `bin` folder.
  • Composer commands are always run from the site root.
  • Downloading additional modules: `composer require "drupal/devel:1.x-dev"`
  • Updating an existing module: `composer update drupal/devel -–with-dependencies`
  • Docksal provides a lot of helpful tool. You can find the list of commands in the documentation.

Version Control

The provided `.gitignore` in the root contains all directories expected to be installed using composer.

When you first install your project, Composer will create a file called `composer.lock` that keeps track of your dependencies and which version is installed.

You want to Commit `composer.lock` ! This will ensure that anyone collaborating on the project will also install the same versions when running `composer install`

Further Information

The codebase of OpenEDU is hosted here and contains information about Installation, Updating and Changelog.