tomfairey / softengandagile-nontrivialwebapp

Development artifacts for my non-trivial web application, developed as required for the level 5 module "Software Engineering and Agile"

Non-trivial Web Application

Development artifacts for my non-trivial web application, developed as required for the level 5 module "Software Engineering and Agile".

Quick Start

NOTE: Ensure the docker daemon is running before attempting to run any of these commands

Use docker to get started with all dependencies handled automatically:

docker compose up -d

Contributing/Development

Docker can also be used to get a quick start:

docker compose -f docker-compose-dev.yml up --build

Backend (Python)

Python based

Frontend (?)

Single page application

softengandagile-nontrivialwebapp's Issues

Implement a frontend framework

User Story

As a… Software engineer

I want… To have an existing frontend framework

So that… I can build upon existing code adding functionality as-per requirements

Context

A frontend framework is required to begin development on the wider project, without developers are unable to add functionality and may be forced to duplicate code (against DRY principle). This should allow for modularisation of code and be commented appropriately.

Requirements

• Code should be modularised
• Framework should be easily extensible
• Must be executable in docker for an easy developer experience
• Should be executable in docker for production deployments

Solution Design

Astro.js should be used within a Node.js Docker container, this should expose the API web server on port 80 allowing for users to be able to access the project.

Technical Tasks

• Setup a node project utilising the Astro.js library
• Configure a docker compose service to allow for local development
• Configure a page at /status that returns a 200 code to signify the instance is operational

Resource

• /frontend/*
• docker-compose-dev.yml

Delivery Details

• Initial Frontend website

Test Approach

The service should be available at port 80 when locally running and should return a valid HTTP response

Implement an initialiser script

User Story

As a… Software engineer

I want… To have a database initialiser script

So that… I can easily build and extend functionality without worrying about database state

Context

An initialiser script is required to begin development so developers can reset their local databases easily without having to worry about contamination with non-committed data structures or data errors. This should also be usable for the initial database setup when freshly deploying to production.

Requirements

• Must be executable in docker for an easy developer experience
• Should be executable in docker for production deployments

Solution Design

Psycopg3 should be used within a Python Docker container, this execute and exit with a success code when completed naturally or exit with an error code when unsuccessful. This should also have a state in the database so it can be tracked whether the script has previously executed successfully.

Technical Tasks

• Setup a python project utilising the psycopg library
• Configure a docker compose service to allow for local development
• Configure dependencies in docker compose as such this is the first application to run and the reset of the project shall only follow when successfully completed

Resource

• /initialiser/*
• docker-compose-dev.yml

Delivery Details

• Support backend operation and data handling

Test Approach

The service should generate database structures that the backend scripts can interact with, this can be manually confirmed using a tool such as pgAdmin.

Implement a backend framework

User Story

As a… Software engineer

I want… To have an existing backend framework

So that… I can build upon existing code adding functionality as-per requirements

Context

A backend framework is required to begin development on the wider project, without developers are unable to add functionality and may be forced to duplicate code (against DRY principle). This should allow for modularisation of code and be commented appropriately.

Requirements

• Code should be modularised
• Framework should be easily extensible
• Must be executable in docker for an easy developer experience
• Should be executable in docker for production deployments

Solution Design

FastAPI should be used within a Python Docker container, this should expose the API web server on port 80 allowing for the frontend project to communicate with it.

Technical Tasks

• Setup a python project utilising the FastAPI library
• Configure a docker compose service to allow for local development
• Configure a page at /status that returns a 200 code to signify the instance is operational

Resource

• /backend/*
• docker-compose-dev.yml

Delivery Details

• Initial Backend API

Test Approach

The service should be available at port 80 when locally running and should return a valid HTTP response