Define functional and non-functional requirements for MVP

[harley-harris]

What?

As a user, I want to use a service which allows me to find elected representatives using UK postcodes.

Why?

So that there is a clear definition of what the MVP is, which will streamline the development process of the service

Acceptance Criteria?

A list that contains all the minimum functional and non-functional requirements for the service to work.

[harley-harris]

MVP functional requirements (code the happy path only):

• Web page with one field form input, submit and paragraph to store response from server
• POST request functionality
• Client side validation of postcode with regex (quick and easy for MVP, maximises value as time taken to implement is low - consider user needs for getting information quicker)
• Routes set-up in Express.JS:

  • GET route for initial webpage load
  • POST route to handle user submitted postcode, which redirects user back to / route

• Using postcode, obtain parliamentary constituency from postcodes.io
• Using parliamentary constituency, obtain full name and title from member-api at this endpoint: https://members-api.parliament.uk/api/Location/Constituency/Search?searchText=Henley&skip=0&take=20
• Unit test all functions using Jest

MVP non-functional requirements:

Security — No database or sensitive data being stored in backend. Risk of injection as taking in user data from form, so some form of validation/sanitisation needed. Monitoring of project dependencies optional (dependabot?).

Capacity — Capacity not a priority (If the server running the webpage was becoming overloaded, could probably Dockerize the service and spin up a few more instances of the service to handle more requests).

Compatibility — Product should meet minimum requirements for a deployed GOV.UK web application (link to source?)

Reliability and Availability — Dependent on availability of postcodes.io and members-api. Product should be readily all hours, every day. The web application should be hosted by a reliable provider (AWS? - a bit of a pretend requirement as I'll just be running this locally, if I were to deploy could try AWS amplify)

Maintainability and Manageability — Dependent on output format of postcodes.io and members-api. Monitoring for updates to these APIs as service will be coupled to them.

Scalability – Scalability not a priority.

Usability — Service will be very simple as it will just contain be a one field form input, submit button and paragraph to store the response. Small fields so it is viewable on mobile.