Merge pull request #12 from jonfairbanks/develop

Develop --> Master
jonfairbanks · Jun 18, 2019 · c7348e5 · c7348e5
2 parents 43b255f + 416d56f
commit c7348e5
Show file tree

Hide file tree

Showing 21 changed files with 643 additions and 2,326 deletions.
diff --git a/.gitignore b/.gitignore
@@ -22,3 +22,4 @@ server/config/config.js
 server/config/redis.js
 .vscode/settings.json
 client/src/config/config.js
+server/.env
diff --git a/README.md b/README.md
@@ -10,17 +10,18 @@ Yo Dawg, heard you're tired of remembering URLs
 
 - ### Server
 
-  - [Express](https://expressjs.com/)- Node.js Framework for Building REST APIs
-  - [MongoDB](http://mongodb.com/)- Document Oriented NoSQL Database
-  - [Mongoose](https://http://mongoosejs.com)- MongoDB Object Modeling
-  - [Valid-url](https://github.com/ogt/valid-url)- URL Validation Functions
-  - [Nginx](https://www.nginx.com)- Reverse Proxy
+  - [Express](https://expressjs.com/) - Node.js Framework for Building REST APIs
+  - [MongoDB](http://mongodb.com/) - Document Oriented NoSQL Database
+  - [Mongoose](https://http://mongoosejs.com) - MongoDB Object Modeling
+  - [Valid-url](https://github.com/ogt/valid-url) - URL Validation Functions
+  - [Nginx](https://www.nginx.com) - Reverse Proxy
 
 - ### Client
 
   - [React](https://reactjs.org/) - JS Library for Building UI's
-  - [React-router](https://github.com/ReactTraining/react-router)- Complete Routing Library for React
-  - [Materialize css](http://materializecss.com/)- Responsive Front-end Framework Based on Material UI
+  - [React-router](https://github.com/ReactTraining/react-router) - Complete Routing Library for React
+  - [Materialize css](http://materializecss.com/) - Responsive Front-end Framework Based on Material UI
+  - [Auth0 Lock](https://www.npmjs.com/package/auth0-lock) - Universal login and access control
 
 ## Getting Started
 
@@ -117,15 +118,28 @@ location / {
 }
 ```
 
+## Enabling API Authentication
+By default, the Yo backend API is open which would allow anyone who knew your API endpoint to list, edit or even delete links if they chose. To prevent this, you can enable Auth0 authentication for requests between the client and server. 
+
+- Sign up for an Auth0 account @ https://auth0.com
+- Create and Setup a Regular Web Application. Configure it as you see fit.
+- In the Yo config.js files, set the Client and/or Domain provided by Auth0.
+- Before leaving Auth0, create a user account for your application under User & Roles.
+- When starting the Yo client, pass `REACT_APP_AUTH=true` as an ENV variable to enforce user logins.
+- When starting the Yo server, pass `AUTH=true` as an ENV variable to enable authentication checks. 
+- Navigate to Yo and login with the previously created user. If successful, you should be logged into the dashboard successfully. 
+
 ## ☑ TODO
 
 - [x] Auto Update Tab Data
 - [x] Client Dockerfile
 - [x] Server Dockerfile
+- [x] API Authentication
 - [ ] Better Error Handling when Navigating to Unset Names
 - [ ] Pass through for Query Parameters
 - [ ] Swipeable Tabs
 - [ ] Edit/Delete Functionality
+- [ ] Further refactor Home.js
 
 ## Contributers
 Jon Fairbanks - Maintainer
diff --git a/client/package-lock.json b/client/package-lock.json
diff --git a/client/package.json b/client/package.json
@@ -13,11 +13,15 @@
     "eject": "react-scripts eject"
   },
   "dependencies": {
-    "axios": "^0.18.0",
+    "auth0-lock": "^11.16.3",
+    "axios": "^0.19.0",
     "bad-words": "^3.0.2",
+    "fstream": "^1.0.12",
     "materialize-css": "^1.0.0",
     "moment": "^2.24.0",
+    "querystringify": "^2.1.1",
     "react": "^16.8.6",
+    "react-copy-to-clipboard": "^5.0.1",
     "react-dom": "^16.8.6",
     "react-router-dom": "^5.0.0",
     "react-scripts": "^3.0.1",
@@ -29,8 +33,5 @@
     "not ie <= 11",
     "not op_mini all"
   ],
-  "devDependencies": {
-    "babel-eslint": "^10.0.1",
-    "eslint": "^5.16.0"
-  }
+  "devDependencies": {}
 }
diff --git a/client/public/index.html b/client/public/index.html
@@ -16,6 +16,7 @@
     <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
     <meta name="msapplication-TileColor" content="#424242">
     <meta name="theme-color" content="#424242">
+    <meta name="robots" content="noindex">
     <title>Yo - The URL Shortener</title>
   </head>
   <body class="grey darken-3">
@@ -32,6 +33,7 @@
       /* Enable Materialize Tabs */
       $(document).ready(function(){
         $('ul.tabs').tabs();
+        $('.modal').modal();
       });
     </script>
   </body>

diff --git a/client/public/robots.txt b/client/public/robots.txt
@@ -0,0 +1,2 @@
+User-agent: *
+Disallow: /
diff --git a/client/src/APIHelper.js b/client/src/APIHelper.js
@@ -2,7 +2,10 @@ import axios from "axios";
 import constants from "./config/config";
 axios.defaults.baseURL = constants.apiUrl;
 
+var accessToken = localStorage.getItem("accessToken");
+const headers = { 'Content-Type': 'application/json', 'Authorization': "Bearer " + accessToken }
+
 export const createShortUrl = obj => {
-  const requestUrl = "item";
-  return axios.post(requestUrl, obj);
+  const requestUrl = "link";
+  return axios.post(requestUrl, obj, {headers: headers});
 };
diff --git a/client/src/components/home/Home.css b/client/src/components/home/Home.css
@@ -82,4 +82,8 @@ td {
   -moz-hyphens: auto;
   -webkit-hyphens: auto;
   hyphens: auto;
+}
+
+i.small {
+  font-size: 1.5rem;
 }