Merge pull request #334 from topcoder-platform/TCA-517_readme

TCA-517 Port 443 Default Config -> develop

Author: nikolay83

README.md

@@ -62,6 +62,14 @@ You can verify the versions of `nvm`, `node`, and `npm` using the commands below
 | `% nvm current`   | v15.15.0 |
 
 
+>**NOTE:** The `yarn start` command requires the `NVM_DIR` env variable is set.
+
+```zsh
+export NVM_DIR=~/.nvm
+```
+
+If you don't have this set globally, you can create your own [personal config](#personal-config) to define your local nvm dir.
+
 ### Hosting 
 You will need to add the following line to your hosts file. The hosts file is normally located at `/etc/hosts` (Mac). Do not overwrite the existing localhost entry also pointing to 127.0.0.1.
 
@@ -81,9 +89,9 @@ You will need to add the following line to your hosts file. The hosts file is no
 
 >% yarn start
 
-3. Go to https://local.topcoder-dev.com:3000
+3. Go to https://local.topcoder-dev.com
 
->**NOTE**: The default port is 3000, but you can override it in your [personal config](#personal-config).
+>**NOTE**: The site must run on port 443 in order for auth0 to work and for the site to load properly. Mac users will need to run the app with elevated permissions.
 
 ### Local SSL
 
@@ -102,7 +110,7 @@ Otherwise, you will need to override the exception each time you load the site.
 ### Personal Config
 
 1. Add [hostname] to [`/src-ts/config/environments/app-host-environment.type.ts`](/src-ts/config/environments/app-host-environment.type.ts)
-2. Copy an existing config from [`/src-ts/config/environments/environment.*.config.ts`](/src-ts/config/environments/environment.bsouza.config.ts)
+2. Copy an existing config from [`/src-ts/config/environments/environment.*.config.ts`](/src-ts/config/environments/environment.brooke.config.ts)
 3. Rename new config `environment.[hostname].config.ts`
 4. Rename config variable to `EnvironmentConfig[HostName]`
 5. Set the `ENV` variable to `[hostname]`

package.json

@@ -5,7 +5,7 @@
     "scripts": {
         "dev": "yarn react-app-rewired start",
         "start": "sh start-ssl.sh",
-        "start:bsouza": "sudo sh start-ssl-bsouza.sh",
+        "start:brooke": "sudo sh start-ssl-brooke.sh",
         "build": "yarn react-app-rewired build",
         "lint": "tslint 'src-ts/**/*.{ts,tsx}' && eslint 'src*/**/*.{js,jsx,ts,tsx}'",
         "lint:fix": "tslint 'src-ts/**/*.{ts,tsx}' --fix && eslint 'src*/**/*.{js,jsx,ts,tsx}' --fix",

src-ts/config/environments/app-host-environment.type.ts

@@ -1 +1 @@
-export type AppHostEnvironmentType = 'bsouza' | 'default' | 'dev' | 'prod'
+export type AppHostEnvironmentType = 'brooke' | 'default' | 'dev' | 'prod'

src-ts/config/environments/environment.bsouza.config.ts renamed to src-ts/config/environments/environment.brooke.config.ts

@@ -1,7 +1,7 @@
 import { EnvironmentConfigModel } from './environment-config.model'
 import { EnvironmentConfigDefault } from './environment.default.config'
 
-export const EnvironmentConfigBsouza: EnvironmentConfigModel = {
+export const EnvironmentConfigBrooke: EnvironmentConfigModel = {
     ...EnvironmentConfigDefault,
-    ENV: 'bsouza',
+    ENV: 'brooke',
 }

src-ts/config/environments/environment.config.ts

@@ -1,6 +1,6 @@
 import { AppHostEnvironmentType } from './app-host-environment.type'
 import { EnvironmentConfigModel } from './environment-config.model'
-import { EnvironmentConfigBsouza } from './environment.bsouza.config'
+import { EnvironmentConfigBrooke } from './environment.brooke.config'
 import { EnvironmentConfigDefault } from './environment.default.config'
 import { EnvironmentConfigDev } from './environment.dev.config'
 import { EnvironmentConfigProd } from './environment.prod.config'
@@ -12,8 +12,8 @@ function getEnvironmentConfig(): EnvironmentConfigModel {
 
     switch (environment) {
 
-        case 'bsouza':
-            return EnvironmentConfigBsouza
+        case 'brooke':
+            return EnvironmentConfigBrooke
 
         case 'default':
             return EnvironmentConfigDefault

src-ts/tools/learn/README.md

@@ -6,7 +6,7 @@ The Learn tool has its own configuration defined in the [/src-ts/tools/learn/lea
 
 The default configuration expects both the FCC Client and API to be running locally. In most cases, developers probably won't want to run both locally. 
 
->**See** [/src-ts/tools/learn/learn-config/learn.bsouza.config.ts](/src-ts/tools/learn/learn-config/learn.bsouza.config.ts) for an example of how to override the FCC source URLs to use the dev env config.
+>**See** [/src-ts/tools/learn/learn-config/learn.brooke.config.ts](/src-ts/tools/learn/learn-config/learn.brooke.config.ts) for an example of how to override the FCC source URLs to use the dev env config.
 
 >**See** the [main app README](/README.md#personal-config) for instructions for creating a personal config.
 

src-ts/tools/learn/learn-config/learn.bsouza.config.ts renamed to src-ts/tools/learn/learn-config/learn.brooke.config.ts

@@ -2,7 +2,7 @@ import { LearnConfigModel } from './learn-config.model'
 import { LearnConfigDefault } from './learn.default.config'
 import { LearnConfigDev } from './learn.dev.config'
 
-export const LearnConfigBsouza: LearnConfigModel = {
+export const LearnConfigBrooke: LearnConfigModel = {
     ...LearnConfigDev,
     // API: LearnConfigDefault.API,
     CLIENT: LearnConfigDefault.CLIENT,

src-ts/tools/learn/learn-config/learn.config.ts

@@ -1,7 +1,7 @@
 import { EnvironmentConfig } from '../../../config'
 
 import { LearnConfigModel } from './learn-config.model'
-import { LearnConfigBsouza } from './learn.bsouza.config'
+import { LearnConfigBrooke } from './learn.brooke.config'
 import { LearnConfigDefault } from './learn.default.config'
 import { LearnConfigDev } from './learn.dev.config'
 import { LearnConfigProd } from './learn.prod.config'
@@ -10,8 +10,8 @@ function getConfig(): LearnConfigModel {
 
     switch (EnvironmentConfig.ENV) {
 
-        case 'bsouza':
-            return LearnConfigBsouza
+        case 'brooke':
+            return LearnConfigBrooke
 
         case 'dev':
             return LearnConfigDev

start-ssl-brooke.sh

@@ -0,0 +1,3 @@
+export REACT_APP_HOST_ENV=brooke
+export NVM_DIR=~/.nvm
+sh ./start-ssl.sh

start-ssl-bsouza.sh

@@ -2,6 +2,7 @@ export HTTPS=true
 export SSL_CRT_FILE=ssl/server.crt
 export SSL_KEY_FILE=ssl/server.key
 export HOST=local.topcoder-dev.com
+export PORT=443
 source $NVM_DIR/nvm.sh
 nvm use
 yarn react-app-rewired start