Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

7. Frontend

As part of this Sprint you are expected to develop a prototype web-based frontend for the interface layer of your application (connected to your services). You will first, based on your system modelling and use cases, need to develop a User Interface Design that outlines what your website will look like.

We will not be marking your UI Designs - we will only be assessing the proof of concept your present in your pitch. However, you may wish to consider writing a few low-fidelity UI designs (wireframes/sketches) to begin with, and then a higher-fidelity one in a tool such as Lucidchart or Figma.

-Wireframes

-Figma design

-Colour stuff

-Code

-Table comparing which language we are using / platform etc etc UX/UI Design

  • Colour

  • User Experience Factors

Wireframes :

Figma Design :

Layer

Framework

Notes

Current team member knowledge of frameworks

Difficulty of frameworks to learn

How well the framework is documented

Availability / pricing of platforms

React

Front-end

Library

Joshua has minimal. Rest of team has no experience

Free + open source

Angular

Front-end

Full-framework

Team has no experience

-Quite difficult to learn in comparison to React

-Steep learning curve.

Free + open source

Vue

Front-end

Team has no experience

-Challenging to debug

Free + open source

Ext JS

Team has no experience

Different packages :

Community : Free (for up to 5 developers)

Pro: $1300 per developer.

Enterprise: $1900 per developer

Express

Back-end

Team has no experience

Free + open source

Next.js

Back-end

Team has no experience

Free + open source

NodeJS

Team has no experience

Free + open source

Method

Name

Description

Parameters

Return values

Exceptions

POST

/auth/login

Logs user into their account and returns a token for their session

{

email: (String)

password: (String)

}

{

token : (String)

}

400 errors:

  • Invalid password or email

POST

/auth/logout

Logs user out of session and disconnects any tokens associated with them.

{

token: (String)

}

{

}

403:

  • Invalid token

POST

/auth/register

Creates new user and returns token for their session. Valid password is min 8 char, contains at least 1 upper case and 1 digit

{

email: (String)

password: (String)

}

{

token : (String)

}

400:

  • Invalid email or password

  • Email already registered

POST

/auth/remove

Deletes user. Also logs users out of any tokens currently associated with them.

{

token : (String)

}

{

}

403:

  • Invalid token

POST

/api/connect

Generates and returns tokens for UBL XML apis. Should logout/delete any existing tokens connected to session.

{

token : (String)

}

TO UPDATE WITH FINAL API CHOICES

{

send_token : (String)

}

403:

  • Invalid token

POST

/api/disconnect

Logout/delete any existing tokens connected to session.

{

token : (String)

}

{

}

403:

  • Invalid token

POST

/user/data

Updates/sets value of user for XML creation

TODO Add the values for this

{

}

{

}

403:

  • Invalid token

GET

/user/data

Returns values of user for XML creation

TODO Add the values for this

{

}

TODO Add the values for this

{

}

400:

  • No users values have been saved

403:

  • Invalid token