Merge pull request #38 from oslabs-beta/execBranch

Code cleanup

Author: geistnine

Contributors.md

@@ -13,8 +13,14 @@ Below is a list of features and improvements to which you can contribute. If you
 - Clean up unused dependencies from pre-4.0
 - Connecting to PostgreSQL database
   - When connecting to PostgreSQL to grab the data from the database, it takes a really long time to load (approximately 2 minutes); further investigate pg_dump  alternatives for faster loading.
+- Integration and End-to-End testing for the codebase.
+- Live query feedback so users can see what their changes to the canvas look like as queries.
 
 Known bugs/issues
 
 - Table connection (handle) does not automatically render after a foreign key is added and the column data is saved. 
+- In production, remote postgres database connections do not work. We suspect this is due to container environment (nodeJS) not having access to pg_dump command. 
+- In development, WSL/Ubuntu users may have trouble running pg_dump due to version mismatch. Run `sudo apt-get --purge remove postgresql` to clear configuration files and zombie directories before installing postgresql fresh.
+- Undo function will not regress the state of the canvas to the point where it is empty. Whether this is a design choice or an issue is up to you.
+
 

Dockerfile

@@ -1,6 +1,6 @@
 FROM node:16.17.0
 WORKDIR /usr/src/app
 COPY . /usr/src/app
-RUN npm ci && npm cache clean --force && npm run build
+RUN npm ci && npm cache clean --force && npm run build 
 EXPOSE 3000
 ENTRYPOINT npm run start

README.md

@@ -56,19 +56,21 @@
 ---
 
 ### Getting started
-
+You will need your own mySQL and redis databases for backend functions, and Google Cloud project for OAuth.
 - Fork and clone this repo
-- Add a .env file to the root directory
 - 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>
+- 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:
 
 ```bash
 GOOGLE_AUTH_CALLBACK = ''
 DATABASE_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]
@@ -205,4 +207,4 @@ npm run cert
 
 ### License
 
-dbSpy is developed under the MIT license. See more about [dbSpy4.0 updates here](https://github.com/oslabs-beta/dbSpy/releases/tag/v4.0.0).
+dbSpy is developed under the MIT license. See more about dbSpy4.0 updates [here](https://github.com/oslabs-beta/dbSpy/releases/tag/v4.0.0).