update readme

Author: neighbor-peace

README.md

@@ -56,31 +56,33 @@
 
 ### Getting started
 
-You will need your own mySQL and redis databases for backend functions, and Google Cloud project for OAuth.
+You will need your own MySQL database for backend functions.
 
 - Fork and clone this repo
 - Add a db_schemas folder in server directory
-- Add a .env file to the root directory
-- Go to the Google Cloud Platform Console
-- Set up OAuth 2.0 credentials as laid out in <a href="https://support.google.com/cloud/answer/6158849?hl=en">here</a>. Make sure
-  your authorized redirect URI in the credentials you create matches the GOOGLE_AUTH_CALLBACK variable below.
-- Populate the .env file with the newly created code below:
+- Add a .env file to the root directory with the information below:
 
 ```bash
-GOOGLE_AUTH_CALLBACK = ''
-USER_DB_URL = [mysql url for storing user data]
-DEV_SERVER_ENDPOINT = 'http://localhost:3000'
-DEV_CLIENT_ENDPOINT = 'http://localhost:8080'
-CLIENT_ENDPOINT = 'http://localhost:3000'
-GOOGLE_AUTH_CALLBACK = 'http://localhost:3000/api/oauth/google'
-GOOGLE_AUTH_CLIENT_ID = [google auth client id]
-GOOGLE_AUTH_CLIENT_SECRET = [google auth client secret]
-REDIS_URL = [redis url]
-REDIS_PORT = [redis port]
-REDIS_PASSWORD = [redis password]
-REDIS_SECRET = [redis secret]
-ENVIRONMENT = "development"
-TOKEN_KEY = [any string]
+# production environment variables
+USER_DB_URL = <MySQL url for storing user data>
+USER_DB_USER = <user string from USER_DB_URL>
+USER_DB_PW = <password string from USER_DB_URL>
+TOKEN_KEY = <any string>
+
+# testing environment variables
+## encoded SSL data required for GitHub Actions
+SSL_KEY = <base64 encoded SSL key (see SSL Configuration)>
+SSL_CERT = <base64 encoded SSL cert>
+## MySQL and Postgres databases to test remote connection functionality
+MYSQL_TEST_URL = <MySQL url for a test database>
+MYSQL_TEST_USERNAME = <user string from MYSQL_TEST_URL>
+MYSQL_TEST_PW = <password string from MYSQL_TEST_URL>
+PG_TEST_URL = <PostgreSQL url for a test database>
+PG_TEST_USERNAME = <user string from PG_TEST_URL>
+PG_TEST_PW = <password string from PG_TEST_URL>
+## test user with saved schema to test save/load functionality
+TEST_USER_EMAIL = <email string>
+TEST_USER_PW = <password string>
 ```
 
 - Run the following below:
@@ -103,9 +105,11 @@ $ npm run dev
 
 ---
 
-### Connecting with remote MySQL
+### SSL Configuration
 
-- To connect with the SQL database, we must create and configure SSL certificates.
+To connect with the SQL database, we must create and configure SSL certificates.
+
+### Mac
 
 1. Install mkcert; you can learn more about mkcert [here](https://github.com/FiloSottile/mkcert)
 
@@ -119,6 +123,20 @@ npm install -g mkcert
 npm run cert
 ```
 
+### Linux
+
+1. Check mkcert is up to date (v1.5.1 as of publishing)
+
+```bash
+mkcert --version
+```
+
+2. Run the following script
+
+```bash
+npm run cert:linux
+```
+
 ---
 
 # How to Use
@@ -190,6 +208,10 @@ npm run cert
 
 ### Credits/Contributors
 
+- Alexander Tu • [LinkedIn](https://www.linkedin.com/in/atu816/) • [Github](http://github.com/atu816)
+- Michael Costello • [LinkedIn](https://www.linkedin.com/in/mcostello-swe/) • [Github](https://github.com/neighbor-peace)
+- Steven Geiger • [LinkedIn](https://www.linkedin.com/in/sgeiger9/) • [Github](https://github.com/geistnine)
+- Yufa Li • [LinkedIn](https://www.linkedin.com/in/yufa-li/) • [Github](https://github.com/01001101CK)
 - Angel Giron • [LinkedIn](https://www.linkedin.com/in/acgiron/) • [Github](https://github.com/g94angel)
 - John Paul Adigwu • [LinkedIn](https://www.linkedin.com/in/johnpaul-adigwu/) • [Github](https://github.com/engineerous)
 - Kevin Park-Lee • [LinkedIn](https://www.linkedin.com/in/kevin38424/) • [Github](https://github.com/kevin38424)
@@ -203,10 +225,6 @@ npm run cert
 - Kevin Wang • [LinkedIn](https://www.linkedin.com/in/kevin-w-b841b13/) • [Github](https://github.com/kwang929)
 - Kris Magat • [LinkedIn](https://www.linkedin.com/in/kmag/) • [Github](https://github.com/KrisMagat)
 - Santiago Gil Maya • [LinkedIn](https://www.linkedin.com/in/santiago-gil-929721121/) • [Github](https://github.com/santiago-gil)
-- Alexander Tu • [LinkedIn](https://www.linkedin.com/in/atu816/) • [Github](http://github.com/atu816)
-- Michael Costello • [LinkedIn](https://www.linkedin.com/in/mcostello-swe/) • [Github](https://github.com/neighbor-peace)
-- Steven Geiger • [LinkedIn](https://www.linkedin.com/in/sgeiger9/) • [Github](https://github.com/geistnine)
-- Yufa Li • [LinkedIn](https://www.linkedin.com/in/yufa-li/) • [Github](https://github.com/01001101CK)
 
 ---