update README

Author: klyburke

README.md

@@ -52,21 +52,18 @@ You can use Async as a self-hosted communication app for your team. You can also
 - Server-side rendering for fast initial load and SEO.
 - User authentication with Passwordless, cookie, and session.
 - Production-ready Express server with compression, parser, and helmet.
-- Transactional emails (`AWS SES`): welcome, team invitation, and payment.
-- Adding email addresses to newsletter lists (`Mailchimp`): new users, paying users.
-- File upload, load, and deletion (`AWS S3`) with pre-signed request for: Posts, Team Profile, and User Profile.
+- Transactional emails (`AWS SES`): welcome, login, and team invitation.
+- File upload, load, and deletion (`AWS S3`) with pre-signed request for: Comment, Message, Team Profile, and User Profile.
 - Websockets with socket.io v3.
 - Opinionated architecture:
   - keeping babel and webpack configurations under the hood,
   - striving to minimize number of configurations,
-  - `withAuth` HOC to pass user prop and control user access to pages,
   - HOC extensions `MyApp` and `MyDocument`
   - server-side rendering with `Material-UI`,
   - model-specific components in addition to common components.
 - Universally-available environmental variables at runtime.
 - Custom logger (configure what _not_ to print in production).
-- Useful components for any web app: `ActiveLink`, `Confirm`, `Notifier`, `MenuWithLinks`, and more.
-- Analytics with `Google Analytics`.
+- Useful components for any web app: `Confirmer`, `Notifier`, `Loading`, `MenuWithLinks`, and more.
 - Production-ready, scalable architecture:
   - `app` - user-facing web app with Next/Express server, responsible for rendering pages (either client-side or server-side rendered). `app` sends requests via API methods to `api` Express server.
   - `api` - server-only code, Express server, responsible for processing requests for internal and external API infrastructures.
@@ -78,7 +75,7 @@ You can use Async as a self-hosted communication app for your team. You can also
 
 #### Running `api` locally:
 
-- Before running, create a `.env` file inside the `api` folder with the environmental variables as shown below. These variables are also listed in [`.env.example`](https://github.com/async-labs/saas/blob/master/saas/api/.env.example), which you can use as a template to create your own `.env` file inside the `api` foler.
+- Before running, create a `.env` file inside the `api` folder with the environmental variables as shown below.
 
 `api/.env`:
 
@@ -88,57 +85,46 @@ You can use Async as a self-hosted communication app for your team. You can also
   MONGO_URL=
   SESSION_NAME=
   SESSION_SECRET=
-  COOKIE_DOMAIN=
-  
-  # Used in api/server/google.ts
-  GOOGLE_CLIENTID=
-  GOOGLE_CLIENTSECRET=
   
   # Used in api/server/aws-s3.ts and api/server/aws-ses.ts
   AWS_REGION=
   AWS_ACCESSKEYID=
   AWS_SECRETACCESSKEY=
-  
-  # Used in api/server/models/Invitation.ts and api/server/models/User.ts
-  EMAIL_SUPPORT_FROM_ADDRESS=
-  
-  # Used in api/server/mailchimp.ts
-  MAILCHIMP_API_KEY=
-  MAILCHIMP_REGION=
-  MAILCHIMP_SAAS_ALL_LIST_ID=
-  
+  BUCKET_FOR_FILES=
+
+  # Used in api/server/passwordless.tx and api/server/models/User.ts
+  FROM_EMAIL_ADDRESS=
+
   ----------
-  # All env variables above this line are needed for successful user signup
+  # All env variables above this line are required for successful user signup
   
   # Used in api/server/stripe.ts
-  STRIPE_TEST_SECRETKEY=sk_test_xxxxxx
-  STRIPE_LIVE_SECRETKEY=sk_live_xxxxxx
-  
-  STRIPE_TEST_PLANID=plan_xxxxxx
-  STRIPE_LIVE_PLANID=plan_xxxxxx
-  
-  STRIPE_LIVE_ENDPOINTSECRET=whsec_xxxxxx
+  STRIPE_TEST_SECRET_KEY=
+  STRIPE_LIVE_SECRET_KEY=
+  STRIPE_TEST_PRICE_ID=
+  STRIPE_LIVE_PRICE_ID=
+  STRIPE_LIVE_ENDPOINT_SECRET=
   
   # Optionally determine the URL
-  URL_APP="http://localhost:3000"
-  URL_API="http://localhost:8000"
-  PRODUCTION_URL_APP="https://saas-app.async-await.com"
-  PRODUCTION_URL_API="https://saas-api.async-await.com"
+  URL_APP="https://localhost:3000"
+  PRODUCTION_URL_APP="https://1.async-await.com"
+  API_SERVER_ENDPOINT="http://localhost:8000"
+  PRODUCTION_API_SERVER_ENDPOINT="https://api-xphxggip.async-await.com"
+
+  # Used in api/server/api/index.ts
+  ENCRYPTION_KEY=
+
   ```
 
   - Your `.env` file file _must_ have values for the `required` variables. To use all features and third-party integrations, also add the `optional` variables.
-
-  - IMPORTANT: do not publish your actual values for environmentable variables in `.env.example`; this file is public and only meant to show you how your `.env` should look.<br/>
 
-  - IMPORTANT: use your values for `PRODUCTION_URL_APP` and `PRODUCTION_URL_API`. These are values for domain name that you own.
+  - IMPORTANT: use your values for `PRODUCTION_URL_APP` and `PRODUCTION_API_SERVER_ENDPOINT`. These are values for domain name that you own.
 
   - IMPORTANT: The above environmental variables are available on the server only. You should add your `.env` file to `.gitignore` inside the `api` folder so that your secret keys are not stored on a remote Github repo.
 
   - To get value for `MONGO_URL_TEST`, we recommend you use a [free MongoDB at MongoDB Atlas](https://docs.atlas.mongodb.com/) or [$15/month MongoDB at Digital Ocean](https://www.digitalocean.com/products/managed-databases-mongodb/)
+
   - Specify your own name and secret keys for Express session: [SESSION_NAME](https://github.com/expressjs/session#name) and [SESSION_SECRET](https://github.com/expressjs/session#express)
-  - Get `GOOGLE_CLIENTID` and `GOOGLE_CLIENTSECRET` by following the [official OAuth tutorial](https://developers.google.com/identity/sign-in/web/sign-in#before_you_begin). <br/>
-    Important: For Google OAuth app, callback URL is: http://localhost:8000/oauth2callback <br/>
-    Important: You have to enable Google+ API in your Google Cloud Platform account.
 
 - Once `.env` is created, you can run the `api` app. Navigate to the `api` folder, run `yarn install` to add all packages, then run the command below:
   ```
@@ -150,33 +136,30 @@ You can use Async as a self-hosted communication app for your team. You can also
 
 - Navigate to the `app` folder, run `yarn` to add all packages, then run `yarn dev` and navigate to `http://localhost:3000`:
 
-  - A `.env` file in the `app` folder is not required to run, but you can create one to override the default variables. The environmental variables for `.env` in the `app` folder are shown below. You can also refer [`.env.example`](https://github.com/async-labs/saas/blob/master/saas/app/.env.example) for creating your own `.env` file in the `app` folder.<br/>
+  - A `.env` file in the `app` folder is not required to run, but you can create one to override the default variables. The environmental variables for `.env` in the `app` folder are shown below.<br/>
 
   ```
+    NEXT_PUBLIC_URL_APP="http://localhost:3000"
+    NEXT_PUBLIC_PRODUCTION_URL_APP="https://1.async-await.com"
+
+    NEXT_PUBLIC_API_SERVER_ENDPOINT="http://localhost:8000"
+    NEXT_PUBLIC_PRODUCTION_API_SERVER_ENDPOINT="https://api-xphxggip.async-await.com"
+
     NEXT_PUBLIC_STRIPE_TEST_PUBLISHABLEKEY="pk_test_xxxxxxxxxxxxxxx"
     NEXT_PUBLIC_STRIPE_LIVE_PUBLISHABLEKEY="pk_live_xxxxxxxxxxxxxxx"
     
-    NEXT_PUBLIC_BUCKET_FOR_POSTS=
-    NEXT_PUBLIC_BUCKET_FOR_TEAM_AVATARS=
-    NEXT_PUBLIC_BUCKET_FOR_TEAM_LOGOS=
-    
-    NEXT_PUBLIC_URL_APP="http://localhost:3000"
-    NEXT_PUBLIC_URL_API="http://localhost:8000"
-    NEXT_PUBLIC_PRODUCTION_URL_APP=
-    NEXT_PUBLIC_PRODUCTION_URL_API=
-    
     NEXT_PUBLIC_API_GATEWAY_ENDPOINT=
-    NEXT_PUBLIC_GA_MEASUREMENT_ID=
-  ```
+    NEXT_PUBLIC_ENCRYPTION_KEY_FOR_EXTERNAL_SERVICES=
 
-  - IMPORTANT: do not publish your actual values for environmentable variables in `.env.example`; this file is public and only meant to show you how your `.env` should look.<br/>
+    NEXT_TELEMETRY_DISABLED=1
+    
+  ```
 
-  - IMPORTANT: use your values for `PRODUCTION_URL_APP` and `PRODUCTION_URL_API`. These are values for domain name that you own.
+  - IMPORTANT: use your values for `NEXT_PUBLIC_PRODUCTION_URL_APP` and `NEXT_PUBLIC_PRODUCTION_API_SERVER_ENDPOINT`. These are values for domain name that you own.
 
-  - To get `NEXT_PUBLIC_GA_MEASUREMENT_ID`, set up Google Analytics and follow [these instructions](https://support.google.com/analytics/answer/1008080?hl=en) to find your tracking ID.
   - To get `NEXT_PUBLIC_STRIPE_TEST_PUBLISHABLEKEY`, go to your Stripe dashboard, click `Developers`, then click `API keys`.
 
-- For successful file uploading, make sure your buckets have proper CORS configuration. Go to your AWS account, find your bucket, go to `Permissions > CORS configuration`, add:
+- For successful file uploading, make sure your AWS bucket has the proper CORS configuration. Go to your AWS account, find your bucket, go to `Permissions > CORS configuration`, add:
 
 ```
 [
@@ -193,7 +176,7 @@ You can use Async as a self-hosted communication app for your team. You can also
     ],
     "AllowedOrigins":[
       "http://localhost:3000",
-      "https://saas-app.async-await.com"
+      "https://1.async-await.com"
     ],
     "ExposeHeaders":[
       "ETag",
@@ -233,7 +216,7 @@ We give detailed instructions inside Chapter 9 and 10 of our SaaS Boilerplate bo
 - [MongoDB](https://github.com/mongodb/mongo)
 - [Typescript](https://github.com/Microsoft/TypeScript)
 
-For more detail, check `package.json` files in both `app` and `api` folders and project's root.
+For more detail, check `package.json` files in both `app` and `api` folders.
 
 To customize styles, check [this guide](https://github.com/async-labs/builderbook#add-your-own-styles).