[Dev] Complete walkthrough of setup and how to run code

[ryanrightmer]

Description

A more thorough walkthrough end to end that explains how to set everything up, where important resources and documents are located, etc.

Acceptance Criteria

• High degree of confidence a new developer could get set up with minimal intervention
• README updates
• Extra Credit: Film video of setting it up

Who should I contact?

@ryanrightmer @JamesBock @cdpadilla42 @minpat

Size of Ticket

L

[JamesBock]

Had to install a fresh version of Windows about a week ago so I had to go through setting most of the project again. Adding the steps I took to get Postgres running on Ubuntu for posterity

Create the file repository configuration:

  sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'

Import the repository signing key:

wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -

Update the package lists:

sudo apt-get update

Install the latest version of PostgreSQL.

sudo apt-get -y install postgresql

check if server is running

service postgresql status 

start server

sudo service postgresql start

login to psql as default use 'postgres'

sudo -u postgres psql

replace myPassword with your own password

ALTER USER postgres PASSWORD 'myPassword';

exit postgres...or browse as you'd like

\q

add connection string to appsettings.Development.json

 "LocalSQL": {
	"ConnectionString": "Server=127.0.0.1;Port=5432;Database=tenant_file;User Id=postgres;Password=<YourUpdatedPassword>;"
},

[rixong]

Client - Update gql schema from API. Generate query types

Apollo CLI has methods for regenerating graphql-schema.json file from current API and generating TS Types for new and current GQL queries:

Update graphql-schema.json (from_ within tenant-file/portal-app folder):
apollo client:download-schema graphql-schema.json --endpoint=https://api.dev.tenantfile.org/graphql

Update QGL Types (stored in src/types):
npm run generate

• Types are generated using the API schema (graphql-schema.json) and coded queries.