CUE Front Developer Guide 1.14.5-2 Table of Contents 1 Introduction.......................................................................................................................................... 6 1.1 CUE Front for Designers........................................................................................................7 1.1.1 What is Patternlab?...................................................................................................8 1.1.2 What is Twig?............................................................................................................8 1.2 CUE Front for Developers......................................................................................................8 1.2.1 What is a Recipe?.....................................................................................................8 1.2.2 What is GraphQL?.................................................................................................... 9 1.2.3 What Does the Cleaver Do?................................................................................... 10 1.3 The CUE Front Start Pack................................................................................................... 10 2 Getting Started...................................................................................................................................11 2.1 Quick Start for Test/Development........................................................................................ 11 2.1.1 Installing Docker......................................................................................................11 2.1.2 Getting a Publication Pack......................................................................................14 2.1.3 Getting the CUE Front start pack............................................................................15 2.1.4 Installing the CUE Front Components.....................................................................15 2.1.5 Starting CUE Front..................................................................................................19 2.1.6 Managing the CUE Front Containers......................................................................21 2.1.7 Analytics Configuration............................................................................................23 2.2 Quick Start for Designers.....................................................................................................23 2.2.1 Installing for Designers............................................................................................24 2.2.2 Starting the CUE Front Design Tools..................................................................... 24 3 Upgrading...........................................................................................................................................25 3.1 Upgrade Procedure.............................................................................................................. 25 3.1.1 Upgrading Cook and Cleaver..................................................................................26 4 Using CUE Front............................................................................................................................... 27 4.1 Updating a GraphQL Schema..............................................................................................27 4.2 Working with GraphQL......................................................................................................... 28 4.2.1 The GraphiQL Editor............................................................................................... 29 4.2.2 Understanding CUE Front GraphQL Queries..........................................................32 4.2.3 Mapping URLs To GraphQL Queries......................................................................34 4.2.4 GraphQL Snippets...................................................................................................35 4.3 Working With Twig and Patternlab.......................................................................................37 4.3.1 Patternlab Conventions........................................................................................... 39 4.3.2 Standard Template Structure.................................................................................. 40 4.4 Managing Multiple Publications............................................................................................ 42 4.4.1 Shared Templates and Styles.................................................................................43 4.5 Extending CUE Front........................................................................................................... 45 4.6 CUE Front Development Environment................................................................................. 47 5 Writing Waiter Extensions................................................................................................................. 48 5.1 The WaiterExtension Class.................................................................................................. 48 5.2 Registering Hooks................................................................................................................ 48 5.3 Callback Function Return Values.........................................................................................49 5.4 The Extension Hooks........................................................................................................... 49 5.5 Registering Extensions......................................................................................................... 50 5.6 Example Extension...............................................................................................................50 6 Using the Fridge................................................................................................................................ 52 6.1 Fridge as Cook Proxy.......................................................................................................... 52 6.2 Fridge as Content Store Proxy.............................................................................................53 6.3 Using the Fridge as a Cache............................................................................................... 53 6.3.1 Fridge Stocker SSE Configuration.......................................................................... 54 6.3.2 Changing the Change Log Daemon version...........................................................54 6.3.3 Ensuring Plug-in Data is Handled........................................................................... 54 7 Using Data Sources...........................................................................................................................56 7.1 Creating a Data Source........................................................................................................57 7.1.1 Data Source Context...............................................................................................59 7.1.2 Using Filter Aliases................................................................................................. 60 7.2 Using a Data Source............................................................................................................60 7.2.1 The extendedDatasource Function......................................................................... 62 7.2.2 Datasource Function Parameters............................................................................62 7.2.3 Changing The Data Source Context....................................................................... 63 7.3 Data Source Reference........................................................................................................64 7.3.1 Query....................................................................................................................... 64 7.3.2 And.......................................................................................................................... 65 7.3.3 Or.............................................................................................................................65 7.3.4 Not........................................................................................................................... 65 7.3.5 Publication............................................................................................................... 65 7.3.6 Section.....................................................................................................................66 7.3.7 Author...................................................................................................................... 66 7.3.8 Type.........................................................................................................................67 7.3.9 Tag...........................................................................................................................67 7.3.10 Shared Tags..........................................................................................................68 7.3.11 Field....................................................................................................................... 68 7.3.12 Related.................................................................................................................. 69 7.3.13 WithRelationToMe................................................................................................. 70 7.3.14 WithRelationTo.....................................................................................................