No description, website, or topics provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
config
modules
post/img
resources
scripts
server
src
.editorconfig
.gitattributes
.gitignore
ErrorsAndFixes.txt
LICENSE.md
README.md
config.xml
ionic.config.json
package-lock.json
package.json
tsconfig.json
tslint-codeclimate.json
tslint.json

README.md

A Cross Platform App 'Web Word Cloud'

Previously I've worked with AngularJs as the front end JS framework for single page applications. The world has moved on and React and Angular are popular now, so both are worth learning to understand what each offers. But for this application I focused on Angular. Ionic is a technology built on top of Angular which allows cross platform apps to be created which will run on Android or iOS, so I decided to learn it and how Angular works within it.

The Application

The application I wrote to learn Ionic is called WebWordCloud. It uses SVG to render word clouds like the example below and can be played with at: www.webwordcloud.com. The souce code is here: Ionic-WordCloud

The words shown in the word cloud can be taken from any web page on the internet. Hence the name of the app 'Web Word Cloud'.

For example this page from BBC news "Katowice: COP24 Climate change deal to bring pact to life" www.bbc.co.uk/news has been used to create the following image:


Many options are included in the application for choosing the font, shape and style of the text to be rendered:

Writing the application

There is always an element of learning that is required when doing pretty much any coding and when doing something new then this is especially so. Learning the basics from tutorials is a good way to get the ball rolling e.g. ionicframework.com/docs/intro/tutorial/

Next, some examples more specific to what you want to do are helpful. Creating a word cloud and using SVG in Ionic was what I needed and these two sites helped me form the basis of the application:

github.com/proustibat/d3js-ionic. A tutorial app built with Ionic Framework to learn D3.js with Typescript.

github.com/jasondavies/d3-cloud. This is a Wordle-inspired word cloud layout written in JavaScript. It uses HTML5 canvas and sprite masks to achieve near-interactive speeds.

Once the basics were done I looked into what options I could give the user to take the application to the next level.

Adding the option of using different fonts was made possible via the fonts google have available at github.com/google/fonts.

Displaying the word cloud inside a shape was a customisation I made to Jason Davies code. The code he wrote uses a mask to determine where words have already been placed. My change was to simply render a font awesome icon outline on the mask so that words could only be placed in the shape of the icon.

Finally various SVG filters and effects were made available. For examples see some of the effects on this page: www.smashingmagazine.com

Turning a web page into a list of words was made possible via unfluff "An automatic web page content extractor for Node.js!" github.com/ageitgey/node-unfluff


The architecture

I initially planned for the application to be downloadable from the Play and Apple stores as Ionic applications are cross platform. But the performance on devices was not acceptable so I have left it as a web only application.

The problem initially was that the calculation of the word cloud took too long on a device. To resolve this I made this part of the application server side. The final nail in the cross platform coffin was the rendering time on the device which wan't awful, just a bit too sluggish.

The application is made up of 3 parts:

  • The files that make up the browser client (Ionic / Angular).
  • The CORS proxy - needed to avoid cross origin errors (NodeJS).
  • The server which turns a list of words into a word cloud (NodeJS).

Hosting the application

Client

The files that make up the browser client (Ionic / Angular) are hosted by Google in a static web site stored in a Google Cloud Storage bucket. The performance is great with no wake-up time even if the files have not been requested for a while.

cloud.google.com/storage/docs/hosting-static-website


CORS

The CORS anywhere NodeJS server is hosted in Azure as an App service. The hosting plan is F1 (Free) which give 60 minutes a day of compute time, which should be more than enough.

corsproxywebwordcloud.azurewebsites.net


Layout Word Cloud

The server to turn a list of words into a word cloud uses NodeJS which has some C++ dependencies so I put this in a docker container to simplify deployment. Initially this container was hosted on Google, but I ran out of my free credit so I moved it to Azure as an app service running a container.

webwordcloudcontainer.azurewebsites.net

The performance vs cost for light usage can be seen below. My monthly azure credits cover it running under B1.

Dev/Test Tier- A-series compute Cost per month Render Time (seconds)
B1 - 100 total ACU - 1.75 GB memory £29.09 2.1 to 2.5
B2 - 200 total ACU - 3.5 GB memory £58.18 1.7 to 1.8
B3 - 400 total ACU - 7 GB memory £116.44 1.5 to 1.6
Production Tier - Dv2-series compute Cost per month Render Time (seconds)
P1V2 - 210 total ACU - 3.5 GB memory £96.27 0.6 to 0.7
P2V2 - 420 total ACU - 7 GB memory £192.62 0.6 to 0.8
P2V3 - 840 total ACU - 14 GB memory £385.32 0.6 to 0.7
Production Tier - A-series compute Cost per month Render Time (seconds)
S1 - 100 total ACU - 1.75 GB memory £55.43 1.6 to 2.2
S2 - 200 total ACU - 3.5 GB memory £110.86 1.6
S3 - 400 total ACU - 7 GB memory £221.79 1.6

Conclusions

There is a learning curve, but Ionic is good option for cross platform apps if you have Angular/JavaScript and Web skills. It is limited by the computing power of the phones and tablet it runs on, so graphically intense applications may not be a good fit.

Google storage buckets are a great place to host static web sites.


Screenshots

Screenshot0


Screenshot1


Screenshot2


Screenshot3


Screenshot4


Screenshot5