TheDataShed / leeds-digital-festival-app

1 stars 1 forks source link

Leeds Digital Festival App

Overview

We wanted to create a website, iOS and Android app for Leeds Digital Festival. This was to support a talk (by https://github.com/jordanfinners) about how it was created and technologies behind its creation at the festival. The key points for the talk were about:

We'll be loading the talks from the Leeds Digital Festival website. It'll be built on Azure, using Blob Storage and Azure Functions. Github Actions for the build process, with manual releases due to time constrains (Ideally we would automate this in future).

UI

Tools

We'll be using LitElement for the UI alongside existing Material components.

Rollup is the build tool. Karma, Mocha, Sinon and Chai (using Expect) are testing tools.

Commands

Useful commands to know:

Apps

Android

Android is a Trusted Web Activity, which acts as a wrapper this is based off https://github.com/GoogleChromeLabs/svgomg-twa/ This will wrap the website into an application which can be downloaded off Google Play Store. As it just loads the website it does not need to be updated when the website is updated.

iOS

iOS is a Capacitor Wrapper of the website. This displays the website in a WKWebView but with access to native API's. When you change the UI and want to update the iOS app you'll need to do the following:

npm run build
npx cap sync ios

This will build the updated UI and sync these files to the iOS project. You will then need to open xCode and update the version and release a new version of the app.

Project Board

Is available here

Commits

We'll be using gitmoji because I'm a millennial - https://gitmoji.carloscuesta.me/

Squash down your commits to one when Pull Requesting. Commit format:

This is a title

* Bullet point descriptions

TheDataShed/leeds-digital-festival-app#ticketnumber

If it closes the ticket stick Closes at the start of the ticket reference.