Skip to content

davidhwang/drupal-admin-ui

 
 

Repository files navigation

Drupal Admin UI

This is an admin UI for Drupal, built with JavaScript and based on create-react-app.

Demo of vfancy falling back to Drupal for an unknown route

Installation

git clone https://github.com/drupal/drupal
git clone https://github.com/jsdrupal/drupal-admin-ui

cd drupal-admin-ui
yarn install
yarn build

# Link vfancy to Drupal
cd ../drupal
ln -s ../drupal-admin-ui/build vfancy

## Link the support module to Drupal
cd ../drupal/modules
ln -s ../../drupal-admin-ui/admin_ui_support .

## Download the jsonapi module
curl -O https://ftp.drupal.org/files/projects/jsonapi-8.x-1.13.tar.gz
tar zxf jsonapi-8.x-1.13.tar.gz

# Install Drupal
@todo Use the dev-site command
composer install

## Install the support module
drush en admin_ui_support -y

# Start the webserver
php -S localhost:8000
  • Open http://localhost:8000 and install with SQLite
  • Visit http://localhost:8000/vfancy

For Local Development

  • Copy .env to .env.local and comment out PUBLIC_URL
  • Start the Webpack dev server with yarn start
  • Visit http://localhost:3000/

Commands

yarn run <script> Description
start Serves your app at localhost:3000.
build Compiles the application to disk in folder ./build.
test Runs all available tests.
test:unit Starts an interactive test runner for running unit tests with Jest.
test:unit:ci Runs unit tests with Jest and outputs results with JUnit.
test:lint Lints all files.
test:lint:fix Fixes linter errors that can be solved automatically.
test:lint:ci Lints all files and outputs results with JUnit.

Contributing to This Repository

If someone has made a pull request and you would like to add code to their branch, there are a number of ways to move forward. It will be very helpful to get familiar with managing remotes in Git.

  • First, ping them in #javascript to discuss the addition/changes!

  • Once agreed, you can make a pull request to their fork/branch, which once accepted will appear in the pull request to the main jsdrupal/drupal-admin-ui repo

  • Alternatively, they could give you access to modify their branch directly at https://github.com//drupal-admin-ui/settings/collaboration (although bear in mind this will give access to their entire repository fork)

  • If you're unable to agree, or unable to get in touch with the author, you could create a new pull request that incorporates the work from their branch

     git remote add <their-username> [email protected]:<their-username>/drupal-admin-ui.git
     git fetch <their-username>
     git checkout -b <branch-name> <their-username>/<branch-name>
     .
     . work, commit things, etc
     .
     git push <your-fork> <branch-name>
    

About

v fancy ⬅️✌️➡️

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • PHP 50.1%
  • JavaScript 48.2%
  • HTML 1.7%