Hotfix release available: 2024-02-06a "Kaos".
upgrade now! [55.1] (what's this?)
New release available: 2024-02-06 "Kaos".
upgrade now! [55] (what's this?)
Hotfix release available: 2023-04-04a "Jack Jackrum".
upgrade now! [54.1] (what's this?)
New release available: 2023-04-04 "Jack Jackrum".
upgrade now! [54] (what's this?)
Hotfix release available: 2022-07-31b "Igor".
upgrade now! [53.1] (what's this?)
Hotfix release available: 2022-07-31a "Igor".
upgrade now! [53] (what's this?)
New release available: 2022-07-31 "Igor".
upgrade now! [52.2] (what's this?)
New release candidate 2 available: rc2022-06-26 "Igor".
upgrade now! [52.1] (what's this?)
New release candidate available: 2022-06-26 "Igor".
upgrade now! [52] (what's this?)
Hotfix release available: 2020-07-29a "Hogfather".
upgrade now! [51.4] (what's this?)
New release available: 2020-07-29 "Hogfather".
upgrade now! [51.3] (what's this?)
New release candidate 3 available: 2020-06-09 "Hogfather".
upgrade now! [51.2] (what's this?)
New release candidate 2 available: 2020-06-01 "Hogfather".
upgrade now! [51.1] (what's this?)
New release candidate available: 2020-06-01 "Hogfather".
upgrade now! [51] (what's this?)
Hotfix release available: 2018-04-22c "Greebo".
upgrade now! [50.3] (what's this?)
Hotfix release available: 2018-04-22b "Greebo".
upgrade now! [50.2] (what's this?)
workplace-fabric
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
workplace-fabric [2018/06/25 15:07] 27.4.224.65 [Live updates: Room availability and floor map] |
workplace-fabric [2018/07/05 11:02] (current) hari [Profile modification] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Office space hiring with Freespace ====== | + | ====== Office space finding with Freespace ====== |
| ===== Purpose of Freespace ===== | ===== Purpose of Freespace ===== | ||
| Line 24: | Line 24: | ||
| - The response is a success.\\ \\ | - The response is a success.\\ \\ | ||
| - The server has created a new executive in its database.\\ \\ | - The server has created a new executive in its database.\\ \\ | ||
| - | - The server has mailed the executive a registration confirmation email with a confirmation URL. This URL contains a token that will verify the executive from a provisional status to confirmed status.\\ \\ | + | - A new token called the confirmation token has been generated for this executive. This token will be used during the confirmation step. The token will be part of the URL inside the email which is sent to the user.\\ \\ |
| + | - The server has mailed the executive a registration confirmation email with a confirmation URL. This URL contains the token described in the previous step.\\ \\ | ||
| - On the web app, the executive is taken to a page where he/she is asked to check his/her email address for the confirmation email. No further action is possible on this screen.\\ \\ | - On the web app, the executive is taken to a page where he/she is asked to check his/her email address for the confirmation email. No further action is possible on this screen.\\ \\ | ||
| - Assuming success in the previous step, the executive has received the confirmation email for his/her registration. The executive clicks on the confirmation link inside the email.\\ \\ | - Assuming success in the previous step, the executive has received the confirmation email for his/her registration. The executive clicks on the confirmation link inside the email.\\ \\ | ||
| Line 110: | Line 111: | ||
| - Phone number | - Phone number | ||
| - Email address, which is the same as the one registered. Except for this field, all other fields are modifiable. | - Email address, which is the same as the one registered. Except for this field, all other fields are modifiable. | ||
| - | - Whether the executive is left-handed or right-handed: The letters 'L' and 'R' are used to represent the dexterity. | + | - The current city of the executive. Note that this is actively set by the executive and NOT fetched through GPS. |
| - | - The current location of the executive. Note that this is actively set by the executive and NOT fetched through GPS. | + | - The preferred building of the executive. |
| + | - The preferred floor within the preferred building. | ||
| + | - The preferred department within the preferred building and floor. | ||
| ==== Profile modification ==== | ==== Profile modification ==== | ||
| Line 124: | Line 127: | ||
| - Name: Validation is similar to the validation used during registration. | - Name: Validation is similar to the validation used during registration. | ||
| - Phone number: A leading plus sign, followed by upto 16 numerals are allowed. **QUESTION**: //Brackets?// | - Phone number: A leading plus sign, followed by upto 16 numerals are allowed. **QUESTION**: //Brackets?// | ||
| - | - Location: **QUESTION**: //What validation rules are applicable?// | + | - Location: The current city. This is selected from a list of cities supported by Freespace. |
| - | - Left-handed or right-handed: The letter 'L' is saved if the executive is left-handed, otherwise the letter 'R' is used. No other symbols can be used, be it letters, numbers or other characters. | + | - Preferred building: The building at which the app should start. |
| + | - Preferred floor: The floor at which the app should start. | ||
| + | - Preferred department: The department on which the floor map should be centred to start with. | ||
| ==== Live updates: Room availability and floor map ==== | ==== Live updates: Room availability and floor map ==== | ||
| Line 141: | Line 146: | ||
| - If the current page is the floor map,\\ \\ | - If the current page is the floor map,\\ \\ | ||
| - If a space is occupied, then the corresponding dot turns grey. | - If a space is occupied, then the corresponding dot turns grey. | ||
| - | - If a space is vacated, then the corresponding dot turns green. | + | - If a space is vacated, then the corresponding dot turns green.\\ \\ |
| + | |||
| + | ===== My deliverables ===== | ||
| + | |||
| + | Here is a complete scope of what I need to deliver for the web app. This scope is technical in nature and will be accompanied by a formal, but shorter scope [[http://wiki.tech101.in/lib/exe/fetch.php?media=scope-and-proposal.pdf|PDF document]], which is also a proposal. | ||
| + | |||
| + | - Web page: Splash screen | ||
| + | - A place to display product logo | ||
| + | - A place to display copyright information | ||
| + | - Message about the use of cookies on the web app\\ \\ | ||
| + | - Web page: Registration | ||
| + | - Input fields: Text field for name and text field email address | ||
| + | - Validation for name and email address fields as described in the registration workflow. | ||
| + | - Submit button to invoke the API call for registration | ||
| + | - A hyperlink to allow a registered user to skip this page and go to login page. | ||
| + | - A panel to display registration error message\\ \\ | ||
| + | - Web page: Successful registration | ||
| + | - Display message to indicate registration success and prompt the user to check mail.\\ \\ | ||
| + | - Web page: Invalid confirmation token | ||
| + | - Display message to inform user that he/she may have used a tampered confirmation URL.\\ \\ | ||
| + | - Web page: Generate password | ||
| + | - Input fields: A password field for 'Enter password' and a password field for 'Confirm password' | ||
| + | - A hidden input field to store the provisional session token for the user | ||
| + | - Submit button to invoke the API call for saving password to server | ||
| + | - A panel to display error messages from the server\\ \\ | ||
| + | - Web page: Login | ||
| + | - Input fields: A text field for email address and a password field for the password | ||
| + | - Submit button: To invoke the API call to login | ||
| + | - A panel to display error messages from the server | ||
| + | - Use of cookies / local storage to store the user's session token\\ \\ | ||
| + | - Web page: Home, i.e. availability of rentable spaces | ||
| + | - Use of cookies / local storage to retrieve the current user's session token | ||
| + | - API call to server to fetch the profile of the user | ||
| + | - A panel to display the current user's name | ||
| + | - Permission to use Location API | ||
| + | - Use of Location API to determine current location | ||
| + | - Display error message if neither GPS location nor the location on profile is available. | ||
| + | - API call to server to fetch the three nearest buildings and their floors. | ||
| + | - Horizontally stacked tab bar to display the three buildings | ||
| + | - Vertically stacked text panels to display the floor numbers, on the right for right-handed users and on the left for left-handed users. | ||
| + | - Vertically stacked text panels with tiny image thumbnails to display room categories and their numbers available. | ||
| + | - Click event on tab bar causes the following to happen | ||
| + | - Display the floors in that building. | ||
| + | - Invoke API call to fetch the room categories and availability of each | ||
| + | - Display the room availability | ||
| + | - Hyperlink to show floor map | ||
| + | - Listen for broadcasts from service worker (see point 9) and use the data received to update the page with the latest availability.\\ \\ | ||
| + | - Web page: Floor map | ||
| + | - HTML canvas to display SVG | ||
| + | - API call to server to fetch the SVG floor plan of the floor. | ||
| + | - Render the floor plan SVG in the canvas. | ||
| + | - API call to server to fetch data about individual rooms on that floor. | ||
| + | - Vertically stacked text panels that display the names of each room category on the floor. | ||
| + | - Use of co-ordinates in room data to plot dots on the floor map SVG. | ||
| + | - Use of room's status to colour the dots either green or grey. | ||
| + | - Click event on the text panels in point e does the following | ||
| + | - If a room's category matches the category on the clicked panel, then display that room's dot. | ||
| + | - If a room's category does not match the category on the clicked panel, then hide that room's dot. | ||
| + | - Listen for broadcasts from service worker and use the data received to update the colour of the dots for the rooms whose live status is received.\\ \\ | ||
| + | - Service worker for live room status updates | ||
| + | - Connect and stay connected with the server using web socket in order to receive live updates about status of rooms. | ||
| + | - When a room status is received, broadcast that message to the rest of the web app.\\ \\ | ||
| + | - Web page: Profile | ||
| + | - Text panel to display the full name on profile | ||
| + | - Image panel to display profile picture | ||
| + | - Static text panel to display email address | ||
| + | - Text panels to display phone number | ||
| + | - Text panel to display current city and a dropdown to change it. | ||
| + | - Text panel to display preferred building within city and a dropdown to change it. | ||
| + | - Text panel to display preferred floor within building and a dropdown to change it. | ||
| + | - Text panel to display preferred department within floor and a dropdown to change it. | ||
| + | - A file upload control to allow the user to upload a new DP | ||
| + | - API call to the server to submit new profile details (other than email and DP) | ||
| + | - API call to the server to fetch list of cities. | ||
| + | - API call to the server to fetch list of buildings in a city. | ||
| + | - API call to the server to fetch list of floors in a building. | ||
| + | - API call to the server to fetch list of department on a floor. | ||
| + | - API call to the server to upload DP\\ \\ | ||
| + | - Logout | ||
| + | - Delete local storage | ||
| + | - API call to server to delete session token\\ \\ | ||
workplace-fabric.1529919478.txt.gz · Last modified: 2018/06/25 15:07 by 27.4.224.65
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
