Software User's Manual

Transcription

1 Software User's Manual REAL ESTATE INVESTMENT AND REVIEW TOOL Team - 02 Venkata Sravanti Malapaka <Project Manager, Software Architect> Yuxuan Chen <Prototyper, Developer, Trainer> Yonghyun Cho <Requirements Engineer, Developer> Md Shadman Rafid <Operational Concept Engineer, Trainer> Shriraksha Rao <Feasibility Analyst, Trainer> Vikram Mudaliar <Life Cycle Planner, Software Architect> José Gabriel Vicente Hernández <IV and V, Tester> Webber Wang <Tester, Quality Focal Point>

2 Version History Date Author Version Changes made Rationale 11/29/ 18 12/02/ 18 VSM 1.0 Added expected information in each section VSM 1.1 Reflected some changes in the document after team discussion To comply with Instructional ICM-Sw standard To comply with Instructional ICSM- Sw standard UM_TRR_F18a_T02_V1.1 2 Version Date: 12/02/18

3 Table of Contents VERSION HISTORY 2 TABLE OF CONTENTS 3 TABLE OF TABLES 4 TABLE OF FIGURES 5 1. Error! Bookmark not defined Error! Bookmark not defined Error! Bookmark not defined Error! Bookmark not defined Re-installation Error! Bookmark not defined.3 UM_TRR_F18a_T02_V1.1 3 Version Date: 12/02/18

4 Page intentionally left blank UM_TRR_F18a_T02_V1.1 4 Version Date: 12/02/18

5 Table of Figures Figure 1- Homepage of the website..11 Figure 2- Unregistered User search by zip code screen...12 Figure 3- Browse providers screen Figure 4- Filtered search capabilities screen Figure 5- Filtered search capabilities screen Figure 6- Filtered search capabilities screen Figure 7- Filtered search capabilities screen Figure 8-List of Service Provider screen...16 Figure 9-Service Provider profile page Figure 10- home screen of the website Figure 11- Login page...18 Figure 12- User dashboard...18 Figure 13- user dashboard- my providers section.19 Figure 14- user dashboard- settings section..20 Figure 15- user dashboard- activate two-factor authentication.20 Figure 16- Login using two-factor authentication code activated.21 Figure 17- deactivate two-factor authentication...22 Figure 18- reset password screen..23 Figure 19- reset password prompt...23 Figure 20- received with link.23 Figure 21- link shown in on screen.24 Figure 22- Service Provider profile page..24 Figure 23- Service provider edit profile...25 Figure 24- Service provider edit profile fill details form prompt.25 Figure 25- Write a review prompt.26 Figure 26- Service provider profile with added review in Chronological order...26 Figure 27- Track investments screen.27 Figure 28- Add investment details prompt 28 Figure 29- Filled in form illustration.28 Figure 30- added investments screen...29 Figure 31- Investments information and tracking tool graph 29 Figure 32- Add new expenses prompt...30 UM_TRR_F18a_T02_V1.1 5 Version Date: 12/02/18

6 Figure 33- Verify provider option on screen.31 Figure 34-Verified provider illustration on screen 34 UM_TRR_F18a_T02_V1.1 6 Version Date: 12/02/18

7 1. Introduction 1.1 System Overview The Real Estate Investment and Review Tool is a search and review website for people who are interested and have the financial capability to invest in property for renting them out for extra income. The website is also used for Real Estate service providers to market and advertise their services on the website. It will serve as a trustworthy platform for investors to search for and find the service providers they are looking for to service their properties and for investors to track the financial performance of their properties. It will save the investors a lot of time, money and effort which they would normally spend on looking for proper service providers. The registered Users like Investors would also have access to a graphical tool for tracking the financial performance of their properties which they would normally do manually on an Excel sheet. The registered users can review and rate service providers so that other users can find that information useful when they search for service providers. The main capabilities of the system are: The website provides prospective investors with a medium to search for trustworthy and capable service providers. Investors can keep track of the financial performance of their properties. Users can review and rate service providers with whom they have worked or know. Service providers can reply to reviews on their page. Admin can use his powers to flag users and delete inappropriate content form the website 1.2 System Requirements Operating System- no specification since this is a pure web-based project Hardware Requirements Hardware Preparation Desktop/Laptop with Safari 11.1, Firefox 61, Chrome 68 Hosting Preparation UM_TRR_F18a_T02_V1.1 7 Version Date: 12/02/18

8 a2hosting.com Delegate Access Prisma File Manager/ FTP Account Software Requirements A laptop with internet connection Browsers Supported: Google Chrome: 68, Mozilla Firefox: 61. Safari: 11.1 RWD/Mobile Capability: Desktop, Laptop. UM_TRR_F18a_T02_V1.1 8 Version Date: 12/02/18

9 2. Installation Procedures 2.1 Initialization procedures 1. Install Node.js V8 a npm install -g concurrently 3. yarn && cd client && yarn && cd../server && yarn a. download every dependencies and install packages 4. yarn dev at project root a. launch the website 2.2 Re-installation yarn && cd client && yarn && cd../server && yarn update every dependencies yarn dev at project root launch the website 2.3 De-installation Kill the process in the command using Ctrl + C UM_TRR_F18a_T02_V1.1 9 Version Date: 12/02/18

10 3. Operational Procedures There are two kinds of Users using this website. They are- Unregistered Users Registered Users Unregistered User- Unregistered User of the website is such a user who is not signed up but just shows interest in browsing the website and in any case he is interested, he will sign up, for using the facilities of the website. Once the user is signed up, he can login and use all the privileges as designated to a register user, along with using these. His privileges are mentioned below- a. Browse Providers Whenever an unregistered user browses the website, he would like to view the list of service providers. Thus, from homepage, Navigate to Browse Providers. UM_TRR_F18a_T02_V Version Date: 12/02/18

11 Figure 1- homepage of the website Then you can see that you are redirected to a page and there is a prompt that appears asking you to enter your zip code. UM_TRR_F18a_T02_V Version Date: 12/02/18

12 Figure 2- Unregistered User search by zip code screen If you enter your zip code, then the list will automatically filter according to the matching zip code of registered users in the website. Figure 3- Browse providers screen UM_TRR_F18a_T02_V Version Date: 12/02/18

13 Else, you can click anywhere on the screen and that zip code pop up will get closed, and you see that the whole list will get populated on the screen. Then, you can also filter your search by the street, state, city, name of a person, phone number Figure 4- Filtered search capabilities screen-1 Figure 5- Filtered Search Capabilities screen-2 UM_TRR_F18a_T02_V Version Date: 12/02/18

14 Additionally, you can also select Provider type as Real estate agent, contractor, property manager, All. By default, it is All, which shows all the available service providers in the website. Figure 6- Filtered Search Capabilities screen-3 We can also add new provider from browser service provider page if you see that a Service Provider in the market is not populated/ not registered with the website. Figure 7- Filtered Search Capabilities screen-4 UM_TRR_F18a_T02_V Version Date: 12/02/18

15 After some search is carried out using the special case options, then you can also enter a space to populate all service providers that are available Note that we also have an auto complete functionality and auto fill for state, city and zip code b. View a service provider User clicks on the name of the service provider and then is redirected to the profile page of the service provider. Figure 8-List of Service Provider screen Then he can see the information of the service provider. UM_TRR_F18a_T02_V Version Date: 12/02/18

16 Figure 9-Service Provider profile page He can see the reviews of that provider but cannot write a review on them All the edit profile and write a review button will seem disabled for the user, since he can only view the profile and not make any changes to the profile. Yet, the map and the contact details are visible to the user He can contact that person using phone or he can also see the rating of that service provider and decide to contact him or not Registered User- Registered User is someone who Signed Up to the website for the first time and then can login to use the features of the website. There are specific functionalities which the Registered User can use apart from the privileges an unregistered user can use a. Login to the system(website)- UM_TRR_F18a_T02_V Version Date: 12/02/18

17 Figure 10- home screen of website Figure 11- Login page UM_TRR_F18a_T02_V Version Date: 12/02/18

18 On login, the Registered User can see the User Dashboard User Dashboard is for Registered user only Figure 12- user dashboard- my investments section This includes options for him like Track investments, saved service providers and Settings. This is a slider and one can easily navigate from one part of the page to the other part by clicking on the tab on the page. The My investments tab will allow users to see their current investments. If the user does not have any investments as of now, then there will not be shown any investments under this tab. But the user can add his investments from this page and these will be reflected to the page where he can track his investments. The Saved Providers tab lets users save the users they likes on the website. This is a shortcut for them to see whose profile they have UM_TRR_F18a_T02_V Version Date: 12/02/18

19 added to the website Figure 13- user dashboard- my providers section The Settings bar contents have the two-factor authentication option If I am the user and after I click on activate 2 factor authentication, which is specific to user, it gives me the code to scan. I need to have the Google Authenticator App for scanning this code in case I am using my Android phone, else, an Iphone user can directly scan it using their camera and the code appears. After the scanning is done and the code is entered, I click on verify button. Two-factor authentication adds an extra layer of security for your account. UM_TRR_F18a_T02_V Version Date: 12/02/18

20 Figure 14- user dashboard- settings section Figure 15- user dashboard- activate two-factor authentication Now in case I need to login again, login with the username and password along with the two-factor code specific to the user. Without the code entered, you cannot login since the two-factor authentication is activated in your account. UM_TRR_F18a_T02_V Version Date: 12/02/18

21 Figure 16- Login using two-factor authentication code activated To disable this function, you can go back to the Settings page of your account and click on deactivate two-factor authentication. Figure 17- deactivate two-factor authentication This will deactivate your two-factor authentication and you can login using your same credentials again. UM_TRR_F18a_T02_V Version Date: 12/02/18

22 The user can also reset his password using the password reset option present in the website. Once the user clicks on reset password link, he will be prompted to enter his ID, to which User will receive the to reset his password. The user can use the link to reset his password and this link expires after 2 hours. Figure 18- reset password screen Figure 19- reset password prompt UM_TRR_F18a_T02_V Version Date: 12/02/18

23 Figure 20- received with link Figure 21- link shown in on screen b. Review a Service Provider User clicks on the name of the service provider and then is redirected to the profile page of the service provider. Figure 22- Service Provider profile page Then he can see the information of the service provider. UM_TRR_F18a_T02_V Version Date: 12/02/18

24 The registered user can edit the information of the service provider by clicking on the pencil mark beside the name of the provider. Figure 23- Service provider edit profile Figure 24- Service provider edit profile fill details form prompt He will be prompted to enter the details in a form and after adding the new details, the profile page is updated with the new details. The registered user can write a review about the service provider by clicking on the write a review button on the page. UM_TRR_F18a_T02_V Version Date: 12/02/18

25 Figure 25- Write a review prompt Figure 26- Service provider profile with added review in Chronological order There will be again seen a prompt to enter the review and rate the service provider in the form of star-rating. The rating which appears on the service provider profile is the average of all the ratings he has received in due course of time. When you add a new review and rate the service provider, the average rating also changes instantly. UM_TRR_F18a_T02_V Version Date: 12/02/18

26 Additionally, on the user profile page, you can also see the contact information and a map showing the current location of the service provider. The contact information has an option to call/ the service provider, onclick of which you will be redirected to call/ the service provider. The user can login/logout anytime while accessing the website. c. Track investments- This option is the replicated functionality of one in the Profile of the registered User. But from here, the user can navigate to his investment tool tracker and see the graph of his investments over time. Figure 27- Track investments screen The user has to add property details to add the investments. When he clicks on the add property option on the investments bar, he will be prompted to input some data on the form which includes the purchase price. UM_TRR_F18a_T02_V Version Date: 12/02/18

27 Figure 28- Add investment details prompt He then enters all the fields and will find the investment occur on the page. Property details page will have all the information related to that property expense Can also add investment from User dashboard - Monthly rent need to be entered & Purchase price will determine the Mortgage down payment, mortgage amount, also has an option to add purchase date Figure 29- Filled in form illustration He can then click on the address of that investment which will take him to another page having the detailed expenses the user has put to get the property. UM_TRR_F18a_T02_V Version Date: 12/02/18

28 Figure 30- added investments screen He can also see the graph of all the investments he has put here. Figure 31- Investments information and tracking tool graph He will also be able to add expenses into this page using the add expense button on the page where the user will enter the details prompted on the screen. Then by clicking on the add expense button, the new expense is added onto the screen. UM_TRR_F18a_T02_V Version Date: 12/02/18

29 Figure 32- Add new expenses prompt User can edit his/her investment details and a User can also delete investment using the bin icon shown on the particular property in the my investments page. d. Export tracking data into a CSV file- The data of expenses can be imported into a CSV file and when the button name Import CSV is clicked, then an excel sheet of all the expenses is downloaded into the system the user is currently accessing the website from. DIRECTIONS TO WEBSITE ADMINISTRATOR- The website administrator must be aware of all the processes and techniques, developments and features followed and explained in the earlier sections of the document. Additionally, we have provided the capability to verify service providers by visiting their profile pages, exclusively to the Admin. The admin has been first signed up using the credentials and post database manipulations for giving editable options to the client, the following features can be seen. UM_TRR_F18a_T02_V Version Date: 12/02/18

30 The admin logs in to the system using the username and password(his credentials). He can then visit any service provider s profile and he will be able to see a button, which gives him an option to verify the provider. Figure 33- Verify provider option on screen if the admin is sure that the provider is a verified person, then he should click on the Verify provider button, which will make a green check mark appear beside the profile of the service provider. UM_TRR_F18a_T02_V Version Date: 12/02/18

31 Figure 34-Verified provider illustration on screen The admin has other functionalities, but they are yet to be implemented and come under evolutionary requirements of the system. 4. Troubleshooting 4.1 Frequently Asked questions Should be updated post interaction of users with the system 4.2 Error Codes and Messages INTERNAL_SERVER_ERROR : Node.js server has issues or some bug in the system. Will need to check code to make sure it compiles okay. GRAPHQL_PARSE_FAILED : The GraphQL query syntax has issues, check type is valid GRAPHQL_VALIDATION_FAILED : The GraphQL data types don t match up to the schema, check query data shape UNAUTHENTICATED : Make sure user is logged in & authenticated FORBIDDEN : Current user does not have access to the page, make sure permissions are granted BAD_USER_INPUT : User data input to the server has issues, double check the data input is validated. Note NPM - a node package manager used for installing Javascript libraries Yarn - a package installer used to install NPM packages 4.3 Note REFERENCES- UM_TRR_F18a_T02_V Version Date: 12/02/18

32 In a duration of 12 weeks, our team used the NDI strategy. Ours is a project that did not have any prototype to begin with. We had to use other examples as reference(yelp, Houzz, Zillow). The entire project was written from scratch. We use some COTS in this project (Google, Zillow, Facebook). The project is written in AngularJs frontend and GraphQL backend, with Prisma as the abstraction for Db interaction. UM_TRR_F18a_T02_V Version Date: 12/02/18