Investment Sim

CMPT-372 - Investment Simulator

This is an Investment Simulator program created for CMPT-372.

Work Flow Expectations:

- Make PRs only for dev branch (dev branches from master)
- Don't merge your own PRs
- Make a branch for every issue

Frontend Information:

How to start the client:

• from the root, cd into client
  
• run: npm start
  

Main UI Library: Prime React - https://primereact.org/

What it is:

• Includes a list of components which we can use to help speed up component creation. Site includes well-documented components which contain different class names to modify the components.

Notes on how to use it:

• If using a component from PrimeReact, instead of importing the components directly into the file you're working on, wrap the component into our own component. This way, if we decide to change UI frameworks, we only need to change the code from the component we created rather than changing every single import involving PrimeReact. Or don't :D

---

Main CSS Library: Prime Flex - https://www.primefaces.org/primeflex/

What it is:

• PrimeFlex works hand-in-hand with PrimeReact and has a number of CSS classes which range from using flexbox to organizing a grid layout (the grid classes are extremely from personal experience)

---

Backend Information:

How to start the server:

• from the root, run: npm start
  
• NOTE: nodemon has been installed so dont worry about refreshing the server to apply updates; it will do it automatically
  

How to access the VM through a GUI using Chrome Remote Desktop:

- go to this page: https://remotedesktop.google.com/headless.
- keep pressing the blue button until you get to the "authorize button". Click
the button and on the next page, copy the text below "debian linux".
- ssh into the VM through GCP and once you have access into the terminal, paste and enter the text (NOTE: the text does have a time limit)
- input a passkey which you'll use to access the GUI.
- you can now access the GUI with your created passkey through this page: https://remotedesktop.google.com/

If stuck, check out this tutorial -- the section regarding chrome remote desktop should be helpful.

How to access PostGresql:

- enter: su – postgres
- password is: 12345
- to access the postgres shell, enter: psql
- to access the investment-sim database, enter: psql investment-sim
- if you want to exit the current db, enter: \q
- to list all tables, enter: \dt

UPDATE:

- installed a PostGresql GUI using pgadmin4; can find it inside the top-left activities button of the desktop (search pgadmin)
- this is connected to the local PostGresql DB, which should make it easier for future development

More PostGresql commands here: https://hasura.io/blog/top-psql-commands-and-flags-you-need-to-know-postgresql/

How To update the prisma client:

• use: npx prisma generate --schema=./../prisma/schema.prisma

Team Members:

Andy C. Mathew W. Harry N. Denzel N.