Skip to content
Snippets Groups Projects
Commit 2b4d304e authored by Sascha Eggenberger's avatar Sascha Eggenberger
Browse files

Update README

parent ca5e5dfb
No related branches found
No related merge requests found
CONTENTS OF THIS FILE
---------------------
# Gin Admin Theme
* Introduction
* Requirements
* Installation
* Configuration
* Troubleshooting
* Maintainers
## Contents of this file
- Introduction
- Requirements
- Installation
- Configuration
- Troubleshooting
- Maintainers
## Introduction
INTRODUCTION
------------
A radically new UI layout paired with goodies like a Darkmode will give your Drupal's Admin interface a facelift. The Gin theme also includes things which are currently out of scope for Claro and/or some customisations we're experimenting with for the future. Built on the foundation of Claro from one of the lead designers of Claro & Drupal Design System.
The Gin Admin Theme is an extension of the Claro admin theme which includes some
UX changes which are currently out of scope for Claro and some customizations we
always deliver for our clients.
Gin can be used in a headless environment, as it provides a nice [login screen](https://drupal.org/project/gin_login) which is missing in the default Drupal admin themes.
Gin can be used in a headless environment, as it provides a nice login screen
which is missing in the default Drupal admin themes.
- For a full description of the module, visit the [project page](https://www.drupal.org/project/gin).
- Use the [Issue queue](https://www.drupal.org/project/issues/gin) to submit bug reports and feature suggestions, or track changes.
- Documentation can be found [here](https://www.drupal.org/docs/contributed-themes/gin-admin-theme).
## Requirements
This theme requires Drupal core >= 9.0.
REQUIREMENTS
------------
**Note**: For all functions to work properly, it is recommended that you also install [Gin Toolbar](https://drupal.org/project/gin_toolbar).
This theme requires Drupal core >= 8.8.0 that includes the Claro theme.
## Installation
Install as you would normally install a contributed Drupal theme. See [Gin documentation](https://www.drupal.org/drupalorg/docs/content/gin-admin-theme/installation-and-configuration) or visit https://www.drupal.org/node/1897420 for further information.
INSTALLATION
------------
### Set Gin as default admin theme
* Install as you would normally install a contributed Drupal theme. Visit
https://www.drupal.org/node/1897420 for further information.
- Navigate to Admin > Appearance
- On the same page, click "Install" under Gin
- At the bottom of the page, switch the Administration theme to Gin
## Troubleshooting
CONFIGURATION
-------------
- Setup Gin locally that you can compile CSS & JS files.\
`nvm use && npm i`
* Navigate to Admin > Appearance
* Set Claro as the default frontend & admin theme to temporarily install the
subtheme
* On the same page, click "Install" under Gin
* At the bottom of the page, switch the Administration theme to Gin
* Change back to your old default frontend theme
- Run dev env with watcher and debug output (development process\
`npm run dev`
- Compile assets (for dev branch)\
`npm run build`
TROUBLESHOOTING
---------------
- Setup Gin locally that you can compile CSS & JS files.
* `nvm use && npm i`
- Run dev env with watcher and debug output (development process)
* `npm run dev`
- Compile assets (for dev branch)
* `npm run build`
MAINTAINERS
-----------
## Maintainers
Current maintainers:
* Sascha Eggenberger (saschaeggi) - https://www.drupal.org/u/saschaeggi
- Sascha Eggenberger ([@saschaeggi](https://www.drupal.org/u/saschaeggi))
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment