Skip to content

Latest commit

 

History

History
50 lines (44 loc) · 4.3 KB

README.md

File metadata and controls

50 lines (44 loc) · 4.3 KB

Student Saver

Project Name: Student Saver

Project Description: This project is intended to serve as a budgeting tool for college students who are in need of a system to manage their finances, which are affected by unique factors such as financial aid, tuition and campus housing.

Notes: In order for frontend to work you must run npm install in both frontendUI and loginPage, along swith npm start

Team Members: Nathan Jones, Michael Tran, Logan Spratt, Gabriel West

Application How-To

  1. Begin by installing the project files for Student Saver from this GitHub page via a zip file.
  2. Unzip or move the project files for a directory of your choice.
  3. To begin the process of using Student Saver, ensure that you have downloaded the four libraries required to use our application: Go, NodeJS, Cypress and Axios.
  4. If you have not already downloaded Go, install it here: https://go.dev/dl/
  5. If you have not already downloaded NodeJS, install it here: https://nodejs.org/en
  6. If you have not already downloaded Cypress, install it using this installation guide: https://docs.cypress.io/guides/getting-started/installing-cypress
  7. If you have not already downloaded Axios, install it using this installation guide: https://axios-http.com/docs/intro

Running The Application

  1. Once all application files and libraries are installed, begin running the application by opening a command line terminal.
  2. Using the cd command, set the terminal's directory to the "FullStack" folder of the Student Saver application files. (example command: "cd C:/.../Intro-to-SWE-Project/FullStack")
  3. Once the directory is set correctly, type and execute the command "go run main.go".
  4. Using the cd command, set the terminal's directory to the "src" subsection of the "loginPage" folder of the Student Saver application files. (example command: "cd C:/.../Intro-to-SWE-Project/FullStack/loginPage/src") - this is done in a new terminal.
  5. Once the directory is set correctly, type and execute the command "run npm start".
  6. Using the cd command, set the terminal's directory to the "src" subsection of the "frontendUI" folder of the Student Saver application files. (example command: "cd C:/.../Intro-to-SWE-Project/FullStack/frontendUI/src") - this is done in a new terminal.
  7. Once the directory is set correctly, type and execute the command "run npm start".
  8. Watch as the Student Saver application home page appears on your screen.

Using The Application

  1. Begin using the application by creating an account with a preexisting Google Account with the "Sign In with Google" button.
  2. If your account is tied to a Google Account, select your Google account and login with your Google Account password to begin.
  3. After logging into the Home Screen, begin creating a Budget by clicking on any of the Budget subheadings: "Budget 1", "Budget 2" or "Budget 3".
  4. Once you have clicked a Budget subheading, the page will prompt you to create a Budget by entering several pieces of information into text boxes that indicate what information that you must enter to create the Budget. Enter said information into each respective text box.
  5. Click the "Update button" to save the entered information and create your budget. You may create up to 3 different budgets with Student Saver.
  6. To view the budgets that you've created, click the "Budget" subheading that corresponds to your budget to see a detailed table breaking down each budget.
  7. To edit any of your budgets, click the Budget subheading which corresponds to the Budget you wish to edit or click the "Edit" button below the budget that you wish to edit.
  8. Either option will take you to the corresponding Budget page from step 18- update your budget by entering any new information into the text boxes.
  9. Click the "Update" button to save the budget information.
  10. To delete any of your budgets, click the "Delete" button below the budget that you wish to delete.
  11. To update your profile with your name and college/university, begin by clicking the "Profile" subheading.
  12. Click the "Edit" button on the "Profile" page to enter new profile information. Your email is automatically inputted upon logging in.
  13. Enter your full name and college/university into the corresponding text boxes. Note: You can not delete this information. Only update it.
  14. Click the "Update" button to save your profile information.