Requirements

This document describes all requirements that you must complete as part of finishing your project. You are strongly encouraged to implement your own ideas to showcase the range of your technical abilities - now is the time to push yourself! Don't forget to implement the requirements below, first, though.

Product Requirements

Users must be able to:

TODO

Technical Requirements

TODO

Organisational Requirements

• Work as a team of 4-5 trainees to complete the project together

• Assign clear roles and/or areas of ownership between each team member

• Use Trello to organise your project tasks and visualise your progress

• Define all of your tasks clearly using Trello cards

• Organise your team using weekly sprints

• Run weekly planning sessions to decide on the next tasks and priority order for the sprint

• Submit small pull request(s) for each task, ready to be reviewed by other team members before merging

Deliverables

To submit your finished project, you will need:

• A deployed and working API accessible via a public URL

• Deployed and viewable API docs describing all of your functionality

• A PostMan collection and test script(s) to demo your API

• Code versioned using git along with meaningful commit messages

• Code pushed to a public GitHub repo on your profile

• A README in the root of your repo including:

  • A project description

  • How to run it locally

  • A link to your deployed API, docs and PostMan deliverables

  • Key technical summary & decisions

  • Known limitations & future improvements