miquelvir / xals Goto Github PK

current behaviour
tables can't be restarted

desired behaviour

• in the table action menu, a 'restart' option appears
• clicking the 'restart' option sends a message to the real-time API
• on table restart, the backend server removes all of the courses and sets it back to the initialization state
• all other clients are notified through the real-time API and update the table

current behaviour
the app is in English, support for localization is in place

desired behaviour
all texts are localized to spanish

current behaviour
in the time profile section of the asmin panel, the two inputs do not have a "warning" and "alarm" prefix

desired behaviour
the two inputs have a prefix or label with "alarm" and "warning"

current
the docs are not relevant to Xals

desired
the docs should have articles for the basic concepts in Xals

useful code
this lives here: docs/docs/basics

acceptance criteria

• the docs have a new article in basics explaining what is a 'course'
• the docs have a new article in basics explaining what is a 'restaurant'
• the docs have a new article in basics explaining what is a 'table'
• the docs have a new article in basics explaining what is an 'administrator
• the docs no longer have other sample articles in the basics section (not relevant to Xals)

current
there is only a placeholder

desired
there should be a clean 404 page

useful code
web_app/src/pages/notFoundPage

useful resources
we can use an illustration of https://undraw.co/search

acceptance criteria

• UI

current behaviour
cards take up too much space on screen

desired behaviour

• cards are smaller (probably make table number smaller) to have more cards fit the screen at the same time

current behaviour
tables can't be deleted

desired behaviour

• in the table action menu, a 'delete' option appears
• clicking the 'delete' option sends a message to the real-time API
• on table delete, the backend server removes the table altogether
• all other clients are notified through the real-time API and update the table

useful code
table finalize

current
the models are placeholders from another project

desired
the models are the ones designed to represent the current problem (see /architecture/readme.md)

useful code
this lives here: server/models
sample seed: https://github.com/miquelvir/centrifuga4/blob/main/development/manual_db_utils/generate_sample_db.py
empty seed: https://github.com/miquelvir/centrifuga4/blob/main/development/manual_db_utils/generate_empty_db_heroku.py

acceptance criteria

• the models in server/models have been updated
• a sample seed script has been created in development/manual_db_utils/sample_seed.py
• an empty seed script has been created in development/manual_db_utils/empty_seed.py

current
the UI is just the barebones component

desired
the UI looks nice and modern

useful
go to /app/restaurant in the browser to see a sample use of the tiles
this code lives in web_app/src/pages/restaurantDashboardPage/restaurantDashboardPage.js

• the card takes different colors (green, yellow/orange, red) according to the table.status (['ok', 'warning', 'late'])
• the card displays the time from the last served course
• the card displays the table number

current
the docs are not relevant to Xals

desired
the docs should have articles for the basic concepts in Xals

useful code
this lives here: docs/docs/how-tos

acceptance criteria

• the docs have a new article in how-tos explaining 'how to create a restaurant'
• the docs have a new article in how-tos explaining 'how to create a new access token'
• the docs have a new article in how-tos explaining 'how to access a restaurant using an access token'
• the docs have a new article in how-tos explaining 'how to add root admins'
• the docs have a new article in how-tos explaining 'how to add restaurant admins'
• the docs no longer have other sample articles in the how-tos section (not relevant to Xals)

curent behaviour
a state creates a queue for processing each new message

desired behaviour

• either this is encapsulated in a custom hook with simple call backs, or a better alternative is found without the queue hack

current behaviour
an empty page with the "new" card is shown

desired behaviour

• an illustration (like 404) is shown
• the new card is not shown

current behaviour
always the same default tables are used, not the ones from the admin panel

desired behaviour
the default tables selected in the admin panel are used in the frontend

current behaviour
default tables are not sorted

desired behaviour

• default tables are sorted

current
we have no T&Cs

desired
we should have some basic T&Cs

acceptance criteria

• there is a React page with all the T&Cs
• new users are prompted to check the T&Cs checkbox
• a link to T&C is available in the footer

current
we have no license

desired
we should adhere to some license (investigate which one)

current
there is only a placeholder

desired
there should be the designed dashboard

useful code
web_app/src/pages/restaurantPage

acceptance criteria

• UI
• uses backend API
• #15

current
there is only a placeholder

desired
there should be a Log in with Google implementation

useful code
web_app/src/pages/loginPage

acceptance criteria

• UI
• updates user context
• logs in to the backend (https://developers.google.com/identity/sign-in/web/backend-auth)
• displays the sign in with google button (https://developers.google.com/identity/sign-in/web/sign-in)

current
no frontend tests are run

desired
cd web_app jest is run as an action part of our CI pipeline

useful code
web_app

acceptance criteria

• tests are run on PR
• tests are run on commit

current behaviour
many actions of the action menu require confirmation

desired behaviour

• cancelling a table should require confirmation
• #33

current
the docs use an orange primary colour

desired
the docs use our new primary colour

• discussion: which colour should be the primary colour?
• the docs use the new primary colour

current behaviour
when desserts are delivered, tables still appear waiting for others

desired behaviour

• #30
• #31
• #32

current
not much is discussed

desired
a more complete explanation is added once the frontend is tackled

useful code
this lives here: architecture/readme.md

acceptance criteria

• the docs in the frontend section of architecture/readme.md have been updated

current behaviour
the sort button does not match with the current sort provider

desired behaviour
the icon matches the current search provider

current behaviour
a button is shown in the actions menu with "1st course", "2nd course" and "desserts"

desired behaviour
a button is shown in the actions menu with the label "next course"

current behaviour
the last row grows to fill all the width evenly

desired behaviour
items in the last row have the same width as all other items

technical details
we must switch from using flex to grid with responsive columns

current
there is only a placeholder

desired
there should be an admin dashboard page as designed

useful code
web_app/src/pages/adminDashboardPage

acceptance criteria

• UI
• uses backend API

waiters need to be warned when the courses from a table are ready to be served.

create a dashboard to visualize notifications.

• able to switch between kitchen and waiters dashboard.
• linked actions between dashboards
• a card per table notification

current
the favicon and logo are placeholders

desired
the favicon and logo should be the corporate image of the Xals project

useful code
this lives here: graphic-resources

acceptance criteria

• the resources in graphic-resources have been updated
• the resources in docs/static/img have been updated
• the resources in web_app/public have been updated

current
the docs show the items "pre-enrolment", "payments" and "attendance", and their descriptions.

desired
the docs show updated titles and descriptions for Xals

useful code
this lives here: docs/src/components/HomepageFeatures.js

acceptance criteria

• the docs have updated feature titles (relevant to Xals)
• the docs have updated feature descriptions (relevant to Xals)