Initial Commit.

README.md

@@ -1,68 +1,17 @@
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+# USACS Hacker Badge
 
-## Available Scripts
+### Introduction
+For some developers, it's impractical to invest large amounts of time and effort into crafting a professional portfolio website. However, it's still important that developers and job candidates have a hub that's easily accessible by recuiters, showcasing their work.
 
-In the project directory, you can run:
+The objective of the USACS Hacker Badge project is to create that hub. Given the login credentials to servies including a developers body of work, including Github and Devpost, Hacker Badge will generate a hub for recruiters to view. Additionally, the web app will generate physical QR Code linking to the portfolio so that job candidates can easily share their work with recruiters.
 
-### `npm start`
+### Services
+We're planning to use **Github** and **Devpost** as services to scrape projects for the generated portfolio. We might add more in the future, but these should work fine for now.
 
-Runs the app in the development mode.<br>
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+### Getting Service Content
+Devpost does not have an API that we can use to scrape data from. Github, however, has a dedicated Rest API for accessing user data. Since we'll only be scraping ***public*** information, we may scarpe data from Github as well, instead of using the Rest API.
 
-The page will reload if you make edits.<br>
-You will also see any lint errors in the console.
+That's it for now!
 
-### `npm test`
-
-Launches the test runner in the interactive watch mode.<br>
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `npm run build`
-
-Builds the app for production to the `build` folder.<br>
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.<br>
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
-
-### Analyzing the Bundle Size
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
-
-### Making a Progressive Web App
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
-
-### Advanced Configuration
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
-
-### Deployment
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
-
-### `npm run build` fails to minify
-
-This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
+### Contributors
+Sam Olagun

api/v1/README.md

@@ -0,0 +1,51 @@
+# API Reference
+
+## Introduction
+**GET** — `/api/v1/`
+
+The api is mounted on the `/v1/` subroute of `/api/`. This is version **1**. Mouting the API onto `v1` versus mounting it directly onto `/api/` makes transitioning between different versions much easier.
+
+## Authentication
+**POST** — `/api/v1/auth/login`
+This is the login method. It takes in a json body containing `email` and `password` properties. When sucessfull, it should return a json containing a `token` and a `success` property.
+
+**POST** - `/api/v1/auth/signup`
+Login method. Takes in a email, username, and password. Returns success and token
+
+**POST** `/api/v1/auth/verifyEmail`
+Login method. Takes in a email, username, and password. Returns success and token
+
+`POST` `/api/v1/auth/verifyUsername`
+Login method. Takes in a email, username, and password. Returns success and token
+
+`POST` `/api/v1/auth/deleteUser/`
+Login method. Takes in a username and password. Returns success and token
+
+## User
+
+`POST` `/api/v1/auth/login`
+Login method. Takes in a email (or username) and password. Returns success and token
+
+`POST` `/api/v1/auth/signup`
+Login method. Takes in a email, username, and password. Returns success and token
+
+`POST` `/api/v1/auth/verifyEmail`
+Login method. Takes in a email, username, and password. Returns success and token
+
+`POST` `/api/v1/auth/verifyUsername`
+Login method. Takes in a email, username, and password. Returns success and token
+
+`POST` `/api/v1/auth/deleteUser/`
+Login method. Takes in a username and password. Returns success and token
+
+## Services
+
+`GET` `/api/v1/services/body/:service/:projectName`
+Login method. Takes in a username and password. Returns success and token
+Servies. Github .Devpost.
+returns a list of projects as a json array, has body, project name, etc
+
+`GET` `/api/v1/services/previews/:service`
+Login method. Takes in a username and password. Returns success and token
+Servies. Github .Devpost.
+returns a list of projects as a json array, has body, project name, etc

public/index.html

@@ -8,34 +8,9 @@
       content="width=device-width, initial-scale=1, shrink-to-fit=no"
     />
     <meta name="theme-color" content="#000000" />
-    <!--
-      manifest.json provides metadata used when your web app is installed on a
-      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
-    -->
-    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
-    <!--
-      Notice the use of %PUBLIC_URL% in the tags above.
-      It will be replaced with the URL of the `public` folder during the build.
-      Only files inside the `public` folder can be referenced from the HTML.
-
-      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
-      work correctly both with client-side routing and a non-root public URL.
-      Learn how to configure a non-root public URL by running `npm run build`.
-    -->
-    <title>React App</title>
+    <title>USACS Hacker Badge</title>
   </head>
   <body>
-    <noscript>You need to enable JavaScript to run this app.</noscript>
     <div id="root"></div>
-    <!--
-      This HTML file is a template.
-      If you open it directly in the browser, you will see an empty page.
-
-      You can add webfonts, meta tags, or analytics to this file.
-      The build step will place the bundled scripts into the <body> tag.
-
-      To begin the development, run `npm start` or `yarn start`.
-      To create a production bundle, use `npm run build` or `yarn build`.
-    -->
   </body>
 </html>

src/App.js

@@ -1,27 +1,8 @@
-import React, { Component } from 'react';
-import logo from './logo.svg';
-import './App.css';
+import React, { Component } from "react";
 
 class App extends Component {
   render() {
-    return (
-      <div className="App">
-        <header className="App-header">
-          <img src={logo} className="App-logo" alt="logo" />
-          <p>
-            Edit <code>src/App.js</code> and save to reload.
-          </p>
-          <a
-            className="App-link"
-            href="https://reactjs.org"
-            target="_blank"
-            rel="noopener noreferrer"
-          >
-            Learn React
-          </a>
-        </header>
-      </div>
-    );
+    return <marquee>USACS Hacker Badge</marquee>;
   }
 }
 

src/index.js

@@ -1,12 +1,5 @@
-import React from 'react';
-import ReactDOM from 'react-dom';
-import './index.css';
-import App from './App';
-import * as serviceWorker from './serviceWorker';
+import React from "react";
+import ReactDOM from "react-dom";
+import App from "./App";
 
-ReactDOM.render(<App />, document.getElementById('root'));
-
-// If you want your app to work offline and load faster, you can change
-// unregister() to register() below. Note this comes with some pitfalls.
-// Learn more about service workers: https://bit.ly/CRA-PWA
-serviceWorker.unregister();
+ReactDOM.render(<App />, document.getElementById("root"));