From 44ad7ebcb763e4ad94a6da2cfd2fef081b13ba5a Mon Sep 17 00:00:00 2001 From: Oliver Davies Date: Thu, 6 Jun 2019 08:56:54 +0100 Subject: [PATCH] Update docs --- docs/setting-up-drupal.md | 21 ++++++++++++++++++++- docs/setting-up-vue-js.md | 28 +++++++++++++++++++++++++++- 2 files changed, 47 insertions(+), 2 deletions(-) diff --git a/docs/setting-up-drupal.md b/docs/setting-up-drupal.md index 62ec64b..a21a2c3 100644 --- a/docs/setting-up-drupal.md +++ b/docs/setting-up-drupal.md @@ -1,3 +1,22 @@ # Setting up the Back-End Drupal Application -TODO +The Drupal back-end for my Blue Conf 2019 talk - [Decoupling Drupal with Vue.js](https://www.oliverdavies.uk/talks/decoupling-drupal-vuejs). This was used alongside the Vue.js front-end application for viewing and submitting fictional talk proposals that were stored in Drupal. + +## Prerequisites + +* [Docksal](https://docksal.io) +* [VirtualBox](https://www.virtualbox.org/wiki/Downloads) (can be changed to use Docker natively) + +## Setup instructions + +1. Run `fin init` to initialise the project, including installing all of the Composer dependencies, installing Drupal and importing the original configuration and creating some test content. + + ```bash + cd drupal + + fin init + ``` + +1. Visit `http://blueconf.docksal` to view the Drupal website, or run `fin drush status` to ensure that everything is running. + +1. Run `fin drush uli` to generate a one-time login link in order to access the site. diff --git a/docs/setting-up-vue-js.md b/docs/setting-up-vue-js.md index 5c52f1b..9391bc0 100644 --- a/docs/setting-up-vue-js.md +++ b/docs/setting-up-vue-js.md @@ -1,2 +1,28 @@ # Setting up the Front-End Vue.js Application - TODO + +The Vue.js front-end for my Blue Conf 2019 talk - [Decoupling Drupal with Vue.js](https://www.oliverdavies.uk/talks/decoupling-drupal-vuejs). It is a [Vue CLI](https://cli.vuejs.org) application, and uses [Tailwind CSS](https://tailwindcss.com) for styling. + +## Prerequisites + +* [npm](https://docs.npmjs.com/cli/npm) +* [yarn](https://yarnpkg.com) (optional) + +## Setup instructions + +1. Install the npm dependencies using either `npm` or `yarn`. + + ```bash + cd vuejs + + # Using npm + npm install + + # Using yarn + yarn + ``` + +1. Change the URL to the Drupal back-end if needed in `.env`. + +1. Use `yarn serve` to start a local web server. + +1. Visit the URL (usually `http://localhost:8080`) to view the front-end application.