Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neurocracy/drupal-omnipedia-core
Provides the wiki node framework for Omnipedia.
https://github.com/neurocracy/drupal-omnipedia-core
drupal drupal-module php
Last synced: 17 days ago
JSON representation
Provides the wiki node framework for Omnipedia.
- Host: GitHub
- URL: https://github.com/neurocracy/drupal-omnipedia-core
- Owner: neurocracy
- License: gpl-2.0
- Created: 2022-06-04T01:01:32.000Z (over 2 years ago)
- Default Branch: 6.x
- Last Pushed: 2024-11-06T19:15:53.000Z (3 months ago)
- Last Synced: 2024-11-17T12:39:12.516Z (3 months ago)
- Topics: drupal, drupal-module, php
- Language: PHP
- Homepage:
- Size: 300 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
This contains the source files for the "*Omnipedia - Core*" Drupal module, which
provides the wiki node framework for [Omnipedia](https://omnipedia.app/).
⚠️ ***[Why open source? / Spoiler warning](https://omnipedia.app/open-source)***
----
# Description
This contains the framework for managing our simulated wiki pages (Drupal nodes)
and their revisions. This includes various services to find and interact with
them, and to query and track what simulated revisions they have (one per
in-universe day).
Note that this does not contain the framework to manage the simulated date
system itself; that can be found in the [`omnipedia_date`
module](https://github.com/neurocracy/drupal-omnipedia-date).
This module is named `omnipedia_core` for historical reasons, as it used to
contain more than the wiki node framework. In the future, this module may be
discontinued in favour of a more accurately named module, e.g.
`omnipedia_node`, or `omnipedia_wiki_node`, etc.
----
# Requirements
* [Drupal 10 or 11](https://www.drupal.org/download)
* PHP 8.1
* [Composer](https://getcomposer.org/)
## Drupal dependencies
Follow the Composer installation instructions for these dependencies first:
* The [`omnipedia_access` module](https://github.com/neurocracy/drupal-omnipedia-access).
----
# Installation
## Composer
### Set up
Ensure that you have your Drupal installation set up with the correct Composer
installer types such as those provided by [the `drupal/recommended-project`
template](https://www.drupal.org/docs/develop/using-composer/starting-a-site-using-drupal-composer-project-templates#s-drupalrecommended-project).
If you're starting from scratch, simply requiring that template and following
[the Drupal.org Composer
documentation](https://www.drupal.org/docs/develop/using-composer/starting-a-site-using-drupal-composer-project-templates)
should get you up and running.
### Repository
In your root `composer.json`, add the following to the `"repositories"` section:
```json
"drupal/omnipedia_core": {
"type": "vcs",
"url": "https://github.com/neurocracy/drupal-omnipedia-core.git"
}
```
### Installing
Once you've completed all of the above, run `composer require
"drupal/omnipedia_core:^5.0@dev"` in the root of your project to have
Composer install this and its required dependencies for you.
----
# Major breaking changes
The following major version bumps indicate breaking changes:
* 4.x:
* Requires Drupal 9.5 or [Drupal 10](https://www.drupal.org/project/drupal/releases/10.0.0).
* Increases minimum version of [Hook Event Dispatcher](https://www.drupal.org/project/hook_event_dispatcher) to 3.1, removes deprecated code, and adds support for 4.0 which supports Drupal 10.
* 5.x:
* Now requires PHP 8.1, up from PHP 8.0.
* Now requires the [`omnipedia_access` module](https://github.com/neurocracy/drupal-omnipedia-access).
* 6.x:
* Now requires Drupal core 10.
* Increases minimum version of [Hook Event Dispatcher](https://www.drupal.org/project/hook_event_dispatcher) to 4.0.
* Removed all classes and interfaces deprecated by the following:
* Our custom node entity and storage; [these caused multiple issues](https://github.com/neurocracy/drupal-omnipedia-core/issues/4) and [have been replaced with Typed Entities](https://github.com/neurocracy/drupal-omnipedia-core/issues/19).
* [Main page services and related code](https://github.com/neurocracy/drupal-omnipedia-core/issues/18); they're now found in [the omnipedia_main_page module](https://github.com/neurocracy/drupal-omnipedia-main-page).