This mono-repository contains the system setup for a demo storefront.
Here is an overview of the architecture
This repository is broken into two packages. They are:
The backend for the system. See documentation here
The web app client. See documentation here
The system utilises docker-compose to allow for easy deployment across environments. To get started please follow these steps:
- Install Docker Compose (setup here)
- Navigate to the root folder of this repository
- Run
docker-compose up -d(prefixingsudomay be required) - Wait for docker to pull the necessary images, build the projects and start everything up
- Navigate to http://localhost/
Tested using Docker Compose v1.24.1 and Docker v19.03.8. If you have any difficulties with setup please open an issue in this repository
The following assumptions were made when creating this project
-
Categories are changed infrequently
The web app stores categories in memory over the entirety of a session for speed considerations. This assumes that they will not change frequently.
-
Products change frequently/listings are updated in real-time
Lists are not cached as it is assumed in a real life application products would be updating and also search queries could be tailored to each user for increased conversion rates.
-
There are no requirements to support legacy browsers
The web app is built using modern CSS functionality such as CSS Grid and Flexbox, therefore may not render correctly on legacy, non-evergreen browsers.
-
The number of users is small
This assumption invalidates the necessity of a load-balancer in the system architecture in addition to adding horizontal scalability through kubernetes, sharding etc.
The following frameworks are used:
The pages are split into the following component modules
- Responsive
