Adds to ReadME

Author: Shawn Toubeau

Diff for: README.md

@@ -1 +1,102 @@
-# ActiviX
+# ActiviX
+
+ActiviX is a at home mental health support tool that aids people who suffer from mental health by encouraging them to perform small but meaningful tasks in hope of leading them to a happier life.
+
+This is a Wentworth Institute of Technology senior project by Shawn Toubeau, Morgan Whittemore, and Zachary Griffin.
+
+## Application Details
+
+This repo contains both the frontend React client and a **mock** Express backend server. The current server was built to help design the API routes and allow the client to experience a normal user flow. Eventually it will be replaced with a Django web server that Morgan is working on which will be responsible for more of our backend operations.
+
+## Getting Started
+
+### Package Manager
+
+The client and the server both use `yarn` to manage 3rd party packages and starting the applications. If you don't have yarn installed, you can install it from [here](https://classic.yarnpkg.com/en/docs/install).
+
+### Installing dependencies
+
+You can install dependencies for both the client and the server by running the following in the root directory.
+
+```bash
+yarn run install-dep
+```
+
+### Environment Variables
+
+Both applications depend on some environment variables in order to function. The later sections will tell you how to set them up but for now you can get them ready.
+
+The first 2 will be a set of VAPID keys which are used by the Push and Notification APIs.
+To generate them, run
+
+```bash
+./server/node_modules/.bin/web-push generate-vapid-keys
+```
+
+The other will be a MongoDB URI for connecting to a MongoDB database. If you do not have a instance setup already you can follow this [guide](https://docs.atlas.mongodb.com/getting-started/) to do so.
+
+### Frontend
+
+To setup the client, first change into the `client` folder
+
+```bash
+cd client
+```
+
+and create a `.env` file with the following content. Be sure to insert your **Public VAPID** key that you generated in the previous section.
+
+```env
+REACT_APP_PUBLIC_VAPID_KEY=<INSERT-KEY-HERE>
+```
+
+You can start the client by running
+
+```bash
+yarn run start
+```
+
+and access it at [http://localhost:3000](http://localhost:3000)
+
+### Backend
+
+To setup the server, first change into the `server` folder
+
+```bash
+cd server
+```
+
+and create a `.env` file with the following content. Be sure to insert your **Public VAPID** key, **Private VAPID** key, and **MongoDB URI** that you generated in the previous section.
+
+(**Note**: The **SESSION_SECRET** and **JWT_SECRET** are both string values that are used to sign tokens)
+
+```env
+MONGO_URI=<INSERT-URI-HERE>
+PUBLIC_VAPID_KEY=<INSERT-KEY-HERE>
+PRIVATE_VAPID_KEY=<INSERT-KEY-HERE>
+SESSION_SECRET=secret
+JWT_SECRET=secret
+```
+
+You can start the server by running
+
+(**Note**: If you get an error when you try to start the server, re-running the command a 2nd time usually fixes it. This is because when we run the server in dev mode, it has to transpile the es6 Javascript down to es5 in order to be executable and it tries to start the server at the same time it does that.)
+
+```bash
+yarn run start
+```
+
+and access it at [http://localhost:8000](http://localhost:8000)
+
+## Building for Production
+
+You can build both the client and the server from the root project directory by running
+
+```bash
+yarn run build
+```
+
+This will output production builds at `./client/build` and `./server/dist` where you can then run the app with
+
+```bash
+yarn run prod
+```

Diff for: client/public/arrow_right-01.png

@@ -1597,9 +1597,9 @@
   integrity sha512-oZ0Ib5I4Z2pUEcoo95cT1cr6slco9WY7yiPpG+RGNkj8YcYgJnM7pXmYmorNOReh8MIGcKSqXyeGjxnr8YiZbA==
 
 "@types/babel__core@^7.1.0":
-  version "7.1.6"
-  resolved "https://registry.yarnpkg.com/@types/babel__core/-/babel__core-7.1.6.tgz#16ff42a5ae203c9af1c6e190ed1f30f83207b610"
-  integrity sha512-tTnhWszAqvXnhW7m5jQU9PomXSiKXk2sFxpahXvI20SZKu9ylPi8WtIxueZ6ehDWikPT0jeFujMj3X4ZHuf3Tg==
+  version "7.1.7"
+  resolved "https://registry.yarnpkg.com/@types/babel__core/-/babel__core-7.1.7.tgz#1dacad8840364a57c98d0dd4855c6dd3752c6b89"
+  integrity sha512-RL62NqSFPCDK2FM1pSDH0scHpJvsXtZNiYlMB73DgPBaG1E38ZYVL+ei5EkWRbr+KC4YNiAUNBnRj+bgwpgjMw==
   dependencies:
     "@babel/parser" "^7.1.0"
     "@babel/types" "^7.0.0"
@@ -1729,9 +1729,9 @@
   integrity sha512-ce5d3q03Ex0sy4R14722Rmt6MT07Ua+k4FwDfdcToYJcMKNtRVQvJ6JCAPdAmAnbRb6CsX6aYb9m96NGod9uTw==
 
 "@types/react-dom@*", "@types/react-dom@^16.9.0":
-  version "16.9.5"
-  resolved "https://registry.yarnpkg.com/@types/react-dom/-/react-dom-16.9.5.tgz#5de610b04a35d07ffd8f44edad93a71032d9aaa7"
-  integrity sha512-BX6RQ8s9D+2/gDhxrj8OW+YD4R+8hj7FEM/OJHGNR0KipE1h1mSsf39YeyC81qafkq+N3rU3h3RFbLSwE5VqUg==
+  version "16.9.6"
+  resolved "https://registry.yarnpkg.com/@types/react-dom/-/react-dom-16.9.6.tgz#9e7f83d90566521cc2083be2277c6712dcaf754c"
+  integrity sha512-S6ihtlPMDotrlCJE9ST1fRmYrQNNwfgL61UB4I1W7M6kPulUKx9fXAleW5zpdIjUQ4fTaaog8uERezjsGUj9HQ==
   dependencies:
     "@types/react" "*"
 
@@ -1765,17 +1765,17 @@
     redux ">= 3.7.2"
 
 "@types/react-router@*", "@types/react-router@^5.1.4":
-  version "5.1.4"
-  resolved "https://registry.yarnpkg.com/@types/react-router/-/react-router-5.1.4.tgz#7d70bd905543cb6bcbdcc6bd98902332054f31a6"
-  integrity sha512-PZtnBuyfL07sqCJvGg3z+0+kt6fobc/xmle08jBiezLS8FrmGeiGkJnuxL/8Zgy9L83ypUhniV5atZn/L8n9MQ==
+  version "5.1.5"
+  resolved "https://registry.yarnpkg.com/@types/react-router/-/react-router-5.1.5.tgz#7b2f9b7cc3d350e92664c4e38c0ef529286fe628"
+  integrity sha512-RZPdCtZympi6X7EkGyaU7ISiAujDYTWgqMF9owE3P6efITw27IWQykcti0BvA5h4Mu1LLl5rxrpO3r8kHyUZ/Q==
   dependencies:
     "@types/history" "*"
     "@types/react" "*"
 
 "@types/react@*", "@types/react@^16.9.0":
-  version "16.9.30"
-  resolved "https://registry.yarnpkg.com/@types/react/-/react-16.9.30.tgz#4750857769803c36afeb9ed30139bb77f9607223"
-  integrity sha512-nx+ixghmJkzcDYhtqvmf/jPcBvyH87yfLM+dUDH2n8lE356t18p2flj3mzkT/VO0N1wh6RCjtmWGFI3r/KhCxw==
+  version "16.9.31"
+  resolved "https://registry.yarnpkg.com/@types/react/-/react-16.9.31.tgz#6a543529766c8934ec8a89667376c2e73e9e2636"
+  integrity sha512-NpYJpNMWScFXtx3A2BJMeew2G3+9SEslVWMdxNJ6DLvxIuxWjY1bizK9q5Y1ujhln31vtjmhjOAYDr9Xx3k9FQ==
   dependencies:
     "@types/prop-types" "*"
     csstype "^2.2.0"
@@ -1828,9 +1828,9 @@
     "@types/yargs-parser" "*"
 
 "@types/yup@^0.26.30":
-  version "0.26.33"
-  resolved "https://registry.yarnpkg.com/@types/yup/-/yup-0.26.33.tgz#301faab47b952a4a5f9a06246942cc7cbd09cd95"
-  integrity sha512-QzgcNfDtRIph8CjfoWiu+MJiOUp25Yo7FthuOHLVbtCTyonjOo2YRsFzKo3csDWbTXlw5NedOFH0Nje7yipCrA==
+  version "0.26.34"
+  resolved "https://registry.yarnpkg.com/@types/yup/-/yup-0.26.34.tgz#199329f9fee5074a7385b4a4a25d1559db628aef"
+  integrity sha512-/zH/Yuwl2vC5fgPE+Qtv67iI/o50qLJJsR0KVc86cpDlY2IsRv3yJop1v/9hfNrgy7J8J5BpJM4BMhyFE3QE4w==
 
 "@typescript-eslint/eslint-plugin@^2.10.0":
   version "2.26.0"

Diff for: client/yarn.lock

@@ -9,7 +9,11 @@
   "scripts": {
     "build:client": "cd client && yarn install && yarn run build",
     "build:server": "cd server && yarn install && yarn run build",
-    "build": "yarn run build:client && yarn run build:server"
+    "build": "yarn run build:client && yarn run build:server",
+    "install-dep:client": "cd client && yarn",
+    "install-dep:server": "cd server && yarn",
+    "install-dep": "yarn run install-dep:client && yarn run install-dep:server",
+    "prod": "cd server && NODE_ENV=production node ./dist/app.js"
   },
   "repository": {
     "type": "git",
@@ -21,8 +25,5 @@
   "bugs": {
     "url": "https://github.com/ShawnToubeau/ActiviX/issues"
   },
-  "homepage": "https://github.com/ShawnToubeau/ActiviX#readme",
-  "dependencies": {
-    "concurrently": "^5.1.0"
-  }
+  "homepage": "https://github.com/ShawnToubeau/ActiviX#readme"
 }

Diff for: package.json

@@ -46,26 +46,21 @@ app.use(bodyParser.urlencoded({ extended: true }));
 app.use(express.json());
 app.use(cors());
 
-const sessionSecret = process.env.SESSION_SECRET;
-
-if (sessionSecret) {
-  app.use(
-    session({
-      secret: sessionSecret,
-      resave: true,
-      saveUninitialized: true
-    })
-  );
-} else {
-  console.error('ERROR: Please provide a session secret');
-}
+const sessionSecret = process.env.SESSION_SECRET || 'secret';
+
+app.use(
+  session({
+    secret: sessionSecret,
+    resave: true,
+    saveUninitialized: true
+  })
+);
 
 // Passport config
 app.use(passport.initialize());
 passportConfig(passport);
 
 if (process.env.NODE_ENV === 'production') {
-  console.log('APP.js PROD');
   app.use(compression());
   app.use(morgan('common'));
 

Diff for: server/src/app.js

@@ -4,7 +4,7 @@ const dbUrl = 'http://localhost:5000';
 
 const opts = {
   jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(),
-  secretOrKey: 'secret'
+  secretOrKey: process.env.JWT_SECRET || 'secret'
 };
 
 export const passportConfig = passport => {