Skip to content

Latest commit

 

History

History
80 lines (47 loc) · 4.03 KB

README.md

File metadata and controls

80 lines (47 loc) · 4.03 KB
Raw

Enki - Website

This repo contains the code for the frontend website for Enki Jewellery & Craft Gallery, a shop in Kings Heath, Birmingham, UK, B14 7JT.

The website is built with the sveltekit framework and can be found on this domain https://www.enkionline.com.

The server which handles syncing data between the epos system and the website can be found here. If you run the frontend with out the server you will not have any products populating the online-shop.

App Libraries

We lean on functional programming at the boundaries which is why you find the requests.ts written with the fp-ts library.

Component Structure

Categories -> (and their Children) displayed (recursively) via the HexGrid mounted at the head of the category tree at RootCategories

Products -> via the ProductView and then individually in SingleProduct and DetailedSingleProduct

Basket -> held in local storage via svelte store

Image -> The images only load when they come into view (we use IntersectionObserver for that). This allows us to load all of our products onto one page (no need for pagination)

Categories and NominalCode

  • 'NOT_WEB' -- the category won't be shown on the site but will on the till
  • 'CLASSES' -- the category won't be show in the online shop but will be shown on the classes page and on the till
  • 'CATEGORY' -- means the category will be shown in the online shop and on the till
  • '' (or null) -- means the category will be treated as a variant category and will be shown more like a product
Product
  • 'SellOnWeb' -- this boolean lives in the product data and can be toggled from the epos till
  • 'IsArchived' -- this hides the product from the website and till and can be toggled from the epos till

Local Development

To run the front end locally use npm run dev and find the app running on localhost:5000. The front-end populates product data from the server so run the server to have a full local stack.

Testing

  • npm run test:unit - runs all the unit tests

  • npm run test:integration - runs all the integration tests

Testing Notes

The repo utilises Svelte testing library and vitest to unit test the components and uses Playwright for end-to-end testing, Playwright is coupled with a mock-server.

You may notice a few svelte ticks present across some of the tests, as reactive statements happen asynchronously we need to use the svelte lifecycle tick to wait for the DOM to completely finish updating.

Site Images

The site pulls optimized images from a public gcloud bucket. Everything in the bucket is cached for a year. we "bust" the cache using hashes generated on the server and stored in different places dependant on whether we are dealing with a category, product or tag.

To upload images to products and categories, via a ui see this service

The hashes for the images are pulled from different places for products and categories.

For products the hash is in the image url key in the ProductImages Object.

For categories the hash is added to the category description.

CI/ CD

Argo CD handles the deployment pipeline deploying when a commit on main is tagged with the an incremented semver eg. v01.02.03

Once the deployment is initialised the container runs a pre-deployment hook to generate an upto date sitemap using npm run sitemap-generator. This also runs on a cron once a week early Wednesday morning.

The app is deployed to a slim apline node container and with a node adapter to serve svelte-kit. It's hosted in our kubernetes cluster and has 3 replicas.