Jump to content
schwarzdesign

Architekturführer Köln - SPA in the front, ProcessWire in the back

Recommended Posts

We recently rebuilt the Architekturführer Köln (architectural guide Cologne) as a mobile-first JavaScript web app, powered by VueJS in the frontend and ProcessWire in the backend. Concept, design and implementation by schwarzdesign!

The Architekturführer Köln is a guidebook and now a web application about architectural highlights in Cologne, Germany. It contains detailled information about around 100 objects (architectural landmarks) in Cologne. The web app offers multiple ways to search through all available objects, including:

  • An interactive live map
  • A list of object near the user's location
  • Filtering based on architect, district and category
  • Favourites saved by the user

The frontend is written entirely in JavaScript, with the data coming from a ProcessWire-powered API-first backend.

Frontend

The app is built with the Vue framework and compiled with Webpack 4. As a learning exercise and for greater customizability we opted to not use Vue CLI, and instead wrote our own Webpack config with individually defined dependencies.

The site is a SPA (Single Page Application), which means all internal links are intercepted by the Vue app and the corresponding routes (pages) are generated by the framework directly in the browser, using data retrieved from the API. It's also a PWA (Progressive Web App), the main feature of which is that you can install it to your home screen on your phone and launch it from there like a regular app. It also includes a service worker which catches requests to the API and returns cached responses when the network is not available. The Architekturführer is supposed to be taken with you on a walk through the city, and will keep working even if you are completely offline.

Notable mentions from the tech stack:

  • Vue
  • Vue Router for the SPA functionality
  • VueX for state management and storage / caching of the data returned through the API
  • Leaflet (with Mapbox tiles) for the interactive maps
  • Webpack 4 for compilation of the app into a single distributable
  • Babel for transpilation of ES6+
  • SASS & PostCSS with Autoprefixer as a convenience for SASS in SFCs
  • Google Workbox to generate the service worker instead of writing lots of boilerplate code
  • Bootstrap 4 is barely used here, but we still included it's reboot and grid system

Backend

The ProcessWire backend is API-only, there are no server-side rendered templates, which means the only PHP template is the one used for the API. For this API, we used a single content type (template) with a couple of pre-defined endpoints (url segments); most importantly we built entdpoints to get a list of all objects (either including the full data, or only the data necessary to show teaser tiles), as well as individual objects and taxonomies. The API template which acts as a controller contains all the necessary switches and selectors to serve the correct response in <100 lines of code.

Since we wanted some flexibility regarding the format in which different fields were transmitted over the api, we wrote a function to extract arbitrary page fields from ProcessWire pages and return them as serializable standard objects. There's also a function that takes a Pageimage object, creates multiple variants in different sizes and returns an object containing their base path and an array of variants (identified by their basename and width). We use that one to generate responsive images in the frontend. Check out the code for both functions in this gist.

We used native ProcessWire data wherever possible, so as to not duplicate that work in the frontend app. For example:

  • Page names from the backend translate to URLs in the frontend in the form of route parameters for the Vue Router
  • Page IDs from ProcessWire are included in the API responses, we use those to identify objects across the app, for example to store the user's favourites, and as render keys for object lists
  • Taxonomies have their own API endpoints, and objects contain their taxonomies only as IDs (in the same way ProcessWire uses Page References)

Finally, the raw JSON data is cached using the cache API and this handy trick by @LostKobrakai to store raw JSON strings over the cache API.

Screenshots

architekturfuehrer_front_2_karte.png

architekturfuehrer_front_1_home.png

architekturfuehrer_front_3_object.png

architekturfuehrer_front_4_object_map.png

architekturfuehrer_front_5_search.png

architekturfuehrer_front_6_page.png

architekturfuehrer_back_1_home.png

architekturfuehrer_back_2_object.png

architekturfuehrer_back_3_object_images.png

architekturfuehrer_back_4_taxonomies.png

architekturfuehrer_back_5_object_template.png

architekturfuehrer_back_6_api.png

architekturfuehrer_back_7_api_response.png

lighthouse_report.png

  • Like 29

Share this post


Link to post
Share on other sites

This looks absolutely brilliant! Congratulations for this great work and thanks for sharing it with us!

I've also tried it on my phone and everything just worked 🙂 One thing that was counter intuitive for me was the left arrow icon on the top left corner of the frontpage. On all other pages this icon means "back", on the frontpage there is no "back" of course, but I didn't realize that I was on the frontpage, so it might make sense to remove the icon there?

Another thing: I wanted to share the app with a friend, but the share icon is only available on sub-pages.

  • Like 2
  • Thanks 1

Share this post


Link to post
Share on other sites

Beautiful color contrasts and switching between them
Responsive made with proportional resizing
Pictures going out of focus into the background
The first not irritating popups I have ever seen
-- Einfach WoW --

  • Like 1
  • Thanks 1

Share this post


Link to post
Share on other sites

@netcarver Thanks!

@bernhard Thank you for the QA 😀 Regarding the "back" button, I tried to make it more intelligent, but I got stuck on the history API not having a reliable way to check the last items. I thought about turning it off only on the homepage, but I wanted to have a way to go back to the last page if you go e.g. from an object detail page to the homepage and want back to the object. I'd have to track the last history states manually, since the Vue Router just wraps around the history API and doesn't keep a memory of itself. I'll put that back on the to do list!

As for the share button, we only have that on the object pages in the subnavigation; it would take up to much space too have it on the bottom all the time. Maybe we can put it at the end of every page, or in the navigation. Though it's only supported in Chrome on Android and Safari at the moment, and most browsers have their own native sharing button, so it wasn't the most important feature to us.

@pwired Thank you so much! 🙂

  • Like 1

Share this post


Link to post
Share on other sites

I understand, thx for the explanation 🙂 What program did you use for the mobile screenshots?

  • Like 1

Share this post


Link to post
Share on other sites
38 minutes ago, bernhard said:

I understand, thx for the explanation 🙂 What program did you use for the mobile screenshots?

@bernhard It's a little trick you can do with Google Chrome: In the responsive view mode, select one of the iPhone models in the responsive mode settings bar. In the flyout menu on the upper right, there's an option "show device frame". Only works with some of the devices, I've used "iPhone 6/7/8 Plus". If you take a screenshot (via the same flyout menu) while in responsive design mode with the show device frame option turned on, the device frame will be included in the screenshot.

  • Like 2
  • Thanks 3

Share this post


Link to post
Share on other sites

Nice site, the only issue I came across is scrolling over the map is impossible with the mouse (the map gets zoomed instead).

  • Like 2
  • Thanks 1

Share this post


Link to post
Share on other sites
13 minutes ago, tpr said:

Nice site, the only issue I came across is scrolling over the map is impossible with the mouse (the map gets zoomed instead).

@tpr Thanks! I see your point; I recently wrote a little snippet for leaflet to only activate mouse scrolling after clicking anywhere inside the map, maybe that would make sense here too. I'll put in on the to do list!

Share this post


Link to post
Share on other sites
1 hour ago, tpr said:

Nice site, the only issue I came across is scrolling over the map is impossible with the mouse (the map gets zoomed instead).

Yes. Same here. Also on mobile it is a little annoying. Google does it like this:

Ctrl+Scroll for Desktop:

JCHqyrA.png

2-finger-scroll for mobile:

1ctUQHz.png

  • Like 1
  • Thanks 1

Share this post


Link to post
Share on other sites

Sorry for being late to the party but I had to look around on that site.

As already said here... Awesome!

 

  • Thanks 1

Share this post


Link to post
Share on other sites

Thanks for the feedback everyone, I just made some updates to the app! You may have to fully clear the cache to see the changes immediately, as with the service worker the caching is pretty aggressive.

@bernhard I have tweaked the functionality of the back button. The app now keeps track of the page history independently of the browser history API and only displays the back button if there are at least to items in the history stack. So you shouldn't see the back button on the first page visit, regardless of which route you're on.

@tpr @bernhard For now, I have just disabled scroll wheel zoom for most of the embedded maps; this way, the map won't interfere with the normal page scrolling. The map can still be zoomed with the buttons to the left, and scrool zooming activates after clicking inside the map. Pinch zooming on touch devices should also work as normal. The only exception is the map page (architekturfuehrer.koeln/karte) which can always be zoomed with the scroll wheel; but that page should always fill the entire viewport with nothing to scroll below that, so it shouldn't be an issue there.

  • Like 4

Share this post


Link to post
Share on other sites

Congrats, looks amazing and performs super fast.

Just a short question. Did you have any concerns about SEO impact since everything is done through VUE and there is no real source coude there?

  • Like 1

Share this post


Link to post
Share on other sites
5 minutes ago, Moebius said:

concerns about SEO impact

Googlebot is clever these days. JS-content is no problem for indexing anymore (React, Angular, Vue etc.). Meta tags and page titles are adjusted for every page-view (something a lot of developers simply forget when building SPAs). Of course, you could always improve SEO, e.g. creating a sitemap.xml...

https://www.smashingmagazine.com/2019/05/vue-js-seo-reactive-websites-search-engines-bots/

^ a good read about the subject

 

  • Like 2

Share this post


Link to post
Share on other sites

hey @schwarzdesign, so pleased to see you finally found your way to processwire! awesome work i enjoy frequently on my mobile.

  • Like 1

Share this post


Link to post
Share on other sites

Same experience I got when I wanted to try it on mobile. I thought that was because it was too new when I tried first 🙂 

b2sl3qm.png

  • Like 1

Share this post


Link to post
Share on other sites

@Moebius @dragan @bernhard Well, Google's crawlers can run JS, they even updated the Chromium version their crawlers run on a couple of weeks back, so it should have no problem with the app. architekturfuehrer.koeln ist also an entirely new domain we set up for the app, so there was nothing in the index to begin with. We'll see how the coverage is progressing going forward. I did built a sitemap to help with indexing the site by the way: https://architekturfuehrer.koeln/sitemap. This one is created server-side, though ...

Share this post


Link to post
Share on other sites

Thanks for the detailed write-up! Would you mind sharing how exactly you sync the PW routes with Vue router?

  • Like 1

Share this post


Link to post
Share on other sites

I just published another update that makes full use of the Add to Home Screen functionality in Chrome (though the app is installable in Android Chrome, Android Firefox, iOS Safari and regular Chrome). In particular, there's a new page that explains how to install the PWA on different devices, with a button that triggers the system dialogue for installing the PWA on supported browsers (only Chrome at the moment). This was a bit difficult to implement since there's little common ground between browsers in this regard at the moment, so let me know if you find any bugs or other errors!

@charger ProcessWire only handles specific paths, everything else is routed to the frontend app and handled by the router. A normal ProcessWire installation uses the .htaccess rules to redirect all requests to it's index.php file. Meanwhile, the Vue SPA uses one single index.html as it's entry point and performs all further routing inside the visitor's browser. Since I want most visitors and paths to go to the frontend app, I modified the .htaccess file ProcessWire comes with to only forward specific routes to ProcessWire, and route all other requests to the Vue app:

# .htaccess

# Requests to the root domain without a path should go to the Vue app (index.html) instead of ProcessWire (index.php)

DirectoryIndex index.html index.php index.htm


# This additional RewriteCond comes right before the main RewriteRule from ProcessWire
# It lets ProcessWire handle only calls to specific paths (in this case, the admin url (/cms), the API endpoint and the sitemap which is generated server-side)

RewriteCond %{REQUEST_URI} (^|/)(api|cms|sitemap)
RewriteRule ^(.*)$ index.php?it=$1 [L,QSA]


# Everything else is routed to index.html, so the Vue app will receive the request and the vue-router can show the appropriate page

# Redirect index.html to /
RewriteRule ^index\.html$ / [L,R=301]

# Redirect everything else to the app
FallbackResource /index.html

 

  • Like 2

Share this post


Link to post
Share on other sites

@schwarzdesign I’m sorry, but I think I wasn’t specific enough. How does your router.js look like? 🙂

As you say the routing is handled by Vue. However, I wonder how Vue knows about the routes that exist. Do you manually add the routes to router.js? Or do you grab existing routes via API and then include them in the Vue router config?

  • Like 1

Share this post


Link to post
Share on other sites

@charger 

If you're looking at the JS in Chrome inspector, you'll see

	  , le = new ue("https://architekturfuehrer.koeln/api/v".concat(ae.API_VERSION, "/"),{
		objects: {
			path: "objects"
		},
		object: {
			path: "objects/{identifier}"
		},
		taxonomies: {
			path: "taxonomies"
		},
		walks: {
			path: "walks"
		},
		pages: {
			path: "pages"
		}
	})
	  , he = new ue("https://architekturfuehrer.koeln/",{
		magazin: {
			path: "magazine/results.json"
		}
	});

These are simply JSON that store all the necessary infos, e.g. https://architekturfuehrer.koeln/api/v1/objects

See the OP under "Backend", 1st paragraph.

  • Like 1

Share this post


Link to post
Share on other sites

@charger Oh I see 🙂  Well, frontend routing is completely handled by Vue, so there are no existing routes (as in, provided by ProcessWire). The only routes ProcessWire knows about are the different API endpoints. One of the screenshots in my post shows the URL segments configuration for the API template. Besides that, @dragan's explanation is spot on; since there are only a handful of API endpoints, those are configured manually. It's not inside the vue-router, since that one is only concerned with routes the visitor sees in their browser; I just wrote a little API class that takes a list of endpoints and made an instance available globally through the Vue prototype. For reference, this is the original unminified code with the endpoint definitions:

export const api = new Connector(
    `https://architekturfuehrer.koeln/api/v${config.API_VERSION}/`,
    {
        objects: {
            path: 'objects',
        },
        object: {
            path: 'objects/{identifier}',
        },
        taxonomies: {
            path: 'taxonomies',
        },
        walks: {
            path: 'walks',
        },
        pages: {
            path: 'pages',
        }
    }
);

As for the frontend routes, they are also configured natively inside the Vue app, here's an excerpt:

import ObjectList from './pages/ObjectList.vue';
import SingleObject from './pages/SingleObject.vue';

export default new VueRouter({
	// ...
  	routes: [
      {
            name: 'objects',
            path: '/objekte/:taxonomy([-_.a-zA-Z0-9]+)?/:term([-_.a-zA-Z0-9]+)?',
            component: ObjectList,
        },
        {
            name: 'object',
            path: '/objekt/:object([-_.a-zA-Z0-9]+)',
            component: SingleObject,
            }
        },
      	// ...
    ],
  	// ...
});

 

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By louisstephens
      Going through my long quest to get better with ajax and utilizing the api, I have hit yet another roadblock. I currently have a form with an image field (thanks to flydev for getting that sorted), "title" text input, and a select field set to multiple. In my ajax call, I added in:
      tags = $("#select-tags").val(); form_data.append('tags', tags); $.ajax({ type: 'POST', data: form_data, contentType: false, processData: false, url: '/ajax/upload-preview/', success: function(data) { console.log("Woo"); }, error: function(xhr, ajaxOptions, thrownError) { alert(xhr.responseText); } }); And in the ajax template: 
      $tags = $sanitizer->text($_POST['tags']); $image = $sanitizer->text($_POST['image']); $p = new Page(); $p->template = "preview"; $p->parent = $pages->get("/previews/"); $p->name = $title; $p->title = $title; $p->tags = $tags; $p->save(); If I select a "tag" from the select input and submit, it does indeed add it to the Page Reference field in the backend. However, this does not work with an array being passed to it of multiple options.

      So it does appear that my ajax call is trying to submit multiple options, but I am really just unsure how to get these two added in. I saw in other forums posts of add($page) and even add(array()). Do I need to handle this js array differently or do  I need to foreach through the $tags to add it like:
      foreach($tags as $tag) { $p->tags->add($tag); $p->save(); } I tried this approach, but apparently I am still missing something.
       
      Edit:
      I was doing some tweaking, and I know I can split the js array out like:
      for (i = 0, len = tags.length; i < len; i++) { console.log(tags[i]); } However, I am not sure then how to handle the POST in php if I were to split it out.
    • By louisstephens
      I have been messing around with creating pages from ajax requests, and it has gone swimmingly thus far. However, I am really struggling with creating a page and saving an image via ajax. 
      The form:
      <form action="./" role="form" method="post" enctype="multipart/form-data"> <div> <input type="text" id="preview" name="preview" placeholder="Image Title"> </div> <div> <input type="file" id="preview-name" name="preview-name"> </div> <div> <select id="select-tags" name="select-tags"> <?php $tags = $pages->find("template=tag"); ?> <option value="">Select Your Tags</option> <?php foreach ($tags as $tag) : ?> <option value="<?= $tag->name; ?>"><?= $tag->name; ?></option> <?php endforeach; ?> </select> </div> <div> <button type="button" id="submit-preview" name="submit" class="">Upload Images</button> </div> </form>  
      The ajax in my home template:
      $('#submit-preview').click(function(e) { e.preventDefault(); title = $("#preview").val(); image = $("input[name=preview-name]"); console.log(title); console.log(image); data = { title: title, image: image //not sure if this is actually needed }; $.ajax({ type: 'POST', data: data, url: '/development/upload-preview/', success: function(data) { console.log("Woo"); }, error: function(xhr, ajaxOptions, thrownError) { alert(xhr.responseText); } }); }); And finally in my ajax template:
      $imagePath = $config->paths->assets . "files/pdfs/"; //was from an older iteration $title = $sanitizer->text($_POST['title']); $image = $sanitizer->text($_POST['image']); $p = new Page(); $p->template = "preview"; $p->parent = $pages->get("/previews/"); $p->name = $title; $p->title = $title; $p->save(); $p->setOutputFormatting(false); $u = new WireUpload('preview_image'); $u->setMaxFiles(1); $u->setOverwrite(false); $u->setDestinationPath($p->preview_image->path()); $u->setValidExtensions(array('jpg', 'jpeg', 'gif', 'png', 'pdf')); foreach($u->execute() as $filename) { $p->preview_image->add($filename); } $p->save(); I can complete the file upload but just using a simple post to the same page and it it works well, but I was really trying to work out the ajax on this so I could utilize some modals for success on creation (and to keep my templates a little cleaner). When I do run the code I have, a new/blank folder is created under assets, and a new page is created with the correct title entered. However, no image is being processed. I do get a 200 status in my console. I have searched google for help, but everything seems to be slightly off from my needs. If anyone could help point me in the right direction I would greatly appreciate it. 
    • By louisstephens
      This might be a completely dumb question, but I cant seem to wrap my head around it. I have a page reference field that allows users to select "Tags". In the front end I would like to use the titles as class names for a single item. ie:
      <?php $previews = $pages->find("template=preview"); ?> <?php foreach($previews as $preview): ?> <div class="tagOne TagTwo tagThree"> <!-- use another foreach to output--> <img src="<?=$preview->preview_image->url; ?>" /> </div> <?php endforeach; ?> I am little stumped as I know I need a foreach loop to produce each tag title, but how do I insert them all into one corresponding div class with spaces?
      Whelp, that was the easiest thing, but my brain just didnt "get it". Just put the foreach in the "class" inside of the overall foreach. Ugh 😓
    • By VeiJari
      Hello forum!
      I've yet again stumbled on a head-scratching situation. We have enabled the option on our articles template and events template that it skips the title adding part and goes straight to the form. This is what our customer wants. So when you add a new article or event it automatically names it temporary to "article-0000000" and same with event. Now the problem is that obviously after saving the form we want to change to page url or "name" to the title, like it's normally. 
      Now here's the code for the hook:
      wire()->addHookBefore("Pages::saved(template=tapahtuma|artikkeli)", function($hook) {
        $page = $hook->arguments(0);
        $newUrl = wire()->sanitizer->pageName($page->title); // give it a name used in the url for the page
        wire()->log->message($page->name);
        $page->setAndSave('name', $newUrl);
      });
      I get the correct page and the name and path changes when I log them, but when I try to save it. It just loads and then I get: 
      Fatal error: Allowed memory size of 134217728 bytes exhausted (tried to allocate 262144 bytes) This happens in sanitizer.php
      and then another error: Fatal error: Allowed memory size of 134217728 bytes exhausted (tried to allocate 262144 bytes) in Unknown on line 0
       
      What is happening? Am I not suppose to use sanitizer in this way? When we made a temporary page object in out other hook, the sanitizer worked perfectly.
      Thanks for the help!
    • By louisstephens
      So I reread my first draft, and it made absolutely no sense (I deleted it to hopefully better explain myself).  I am trying to make a system (that to me is a bit complicated) utilizing jquery and processwire together. My whole goal is to put a url like https://domain.com/launch?first_name=jim&occupation=builder in a script tag on another site(just a localhost .php page) to then pull out the data for that person and append to divs etc. Basically, the initial script tag would point to "launch" which has a content-type of "application/javascript". Using jquery, I would pull out the persons name and occupation and then make a specific ajax get request to "domain.com/api" (in json format) for a look up of the person. Essentially then I could pull that particular person's information from the json data, and do with it how I please in the "launch" page.  In processwire, I have a page structure like:
      People -Jim Bob (template: person ) --Occupations (template: basic-page) ---Builder (template: occupation) ---Greeter (template: occupation) It is really just a bunch of people with their occupations and a few fields to the occupation template. With the "api" (template: api) url, I was hoping to return all the data (of people) in json format like:
      Example Format:
      { "id": 1, "title": "Jim Bob", "occupations": { "builder": { "id": 44, "title": "Builder", "years_worked": 1, "etc": "ect", }, "Greeter": { "id": 44, "title": "Greeter", "years_worked": 1, "etc": "ect", }, } } Where I get lost is really outputting the page names and nesting in the occupations into json. I have used Pages2JSON before, but I was a bit lost on how to implement what i was thinking.
       
      I have access to all the local host files, but I was hoping to kind of build out a "system" where I could place the script tag/parameters in any project, and be able to interact with the data without doing an ajax call on the actual site. In a way, this would keep processwire handling all the data and requests, and my other "projects" just with a simple script tag. This might all be way too much/over complicated, but I couldn't quite wrap my head around how to achieve it. 
×
×
  • Create New...