https://github.com/ambient-impact/drupal-ambientimpact-ux
https://github.com/ambient-impact/drupal-ambientimpact-ux
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ambient-impact/drupal-ambientimpact-ux
- Owner: Ambient-Impact
- License: gpl-2.0
- Created: 2023-06-13T16:40:23.000Z (almost 2 years ago)
- Default Branch: 1.x
- Last Pushed: 2025-04-01T20:58:23.000Z (2 months ago)
- Last Synced: 2025-04-01T21:43:47.331Z (2 months ago)
- Language: JavaScript
- Size: 663 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
This Drupal module contains many UX components and enhancements, and their
supporting code.
**Warning**: while this is generally production-ready, it's not guaranteed to
maintain a stable API and may occasionally contain bugs, being a
work-in-progress. Stable releases may be provided at a later date.
----
# Requirements
* [Drupal 9.5 or Drupal 10](https://www.drupal.org/download) ([Drupal 8 is end-of-life](https://www.drupal.org/psa-2021-11-30))
* PHP 8.1
* [Composer](https://getcomposer.org/)
## Drupal dependencies
Before attempting to install this, you must add the Composer repositories as
described in the installation instructions for these dependencies:
* The [`ambientimpact_core`](https://github.com/Ambient-Impact/drupal-ambientimpact-core) and [`ambientimpact_icon`](https://github.com/Ambient-Impact/drupal-ambientimpact-icon) modules.
## Front-end dependencies
To build front-end assets for this project, [Node.js](https://nodejs.org/) and
[Yarn](https://yarnpkg.com/) are required.
----
# 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/ambientimpact_ux": {
"type": "vcs",
"url": "https://github.com/Ambient-Impact/drupal-ambientimpact-ux.git"
}
```
### Installing
Once you've completed all of the above, run `composer require
"drupal/ambientimpact_ux:^1.0@dev"` in the root of your project to have
Composer install this and its required dependencies for you.
## Front-end assets
To build front-end assets for this project, you'll need to install
[Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/).
This package makes use of [Yarn
Workspaces](https://yarnpkg.com/features/workspaces) and references other local
workspace dependencies. In the `package.json` in the root of your Drupal
project, you'll need to add the following:
```json
"workspaces": [
"/modules/custom/*"
],
```
where `` is your public Drupal directory name, `web` by default.
Once those are defined, add the following to the `"dependencies"` section of
your top-level `package.json`:
```json
"drupal-ambientimpact-ux": "workspace:^1"
```
Then run `yarn install` and let Yarn do the rest.
### Optional: install yarn.BUILD
While not required, [yarn.BUILD](https://yarn.build/) is recommended to make
building all of the front-end assets even easier.
### Optional: use `nvm`
If you want to be sure you're using the same Node.js version we're using, we
support using [Node Version Manager (`nvm`)](https://github.com/nvm-sh/nvm)
([Windows port](https://github.com/coreybutler/nvm-windows)). Once `nvm` is
installed, you can simply navigate to the project root and run `nvm install` to
install the appropriate version contained in the `.nvmrc` file.
Note that if you're using the [Windows
port](https://github.com/coreybutler/nvm-windows), it [does not support `.nvmrc`
files](https://github.com/coreybutler/nvm-windows/wiki/Common-Issues#why-isnt-nvmrc-supported-why-arent-some-nvm-for-macoslinux-features-supported),
so you'll have to provide the version contained in the `.nvmrc` as a parameter:
`nvm install ` (without the `<` and `>`).
This step is not required, and may be dropped in the future as Node.js is fairly
mature and stable at this point.
----
# Building front-end assets
This uses [Webpack](https://webpack.js.org/) and [Symfony Webpack
Encore](https://symfony.com/doc/current/frontend.html) to automate most of the
build process. These will have been installed for you if you followed the Yarn
installation instructions above.
If you have [yarn.BUILD](https://yarn.build/) installed, you can run:
```
yarn build
```
from the root of your Drupal site. If you want to build just this package, run:
```
yarn workspace drupal-ambientimpact-ux run build
```
----
# Major breaking changes
The following major version bumps indicate breaking changes:
* 1.x:
* Has been [`git subtree split`](https://shantanoo-desai.github.io/posts/technology/git_subtree/) from [`Ambient-Impact/drupal-modules`](https://github.com/Ambient-Impact/drupal-modules/tree/8.x) into a standalone package; version has been reset to 1.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.