codepath · RobertFontan · Oct 19, 2023 · Oct 19, 2023 · Oct 20, 2023 · Oct 20, 2023
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,25 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+.env
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
diff --git a/README.md b/README.md
@@ -1,48 +1,51 @@
-# [your app name here]
+# [Interview Helper]
+
+Other names: 
+- interview4you
+- interyou
+- interview made easy
 
 CodePath WEB103 Final Project
 
-Designed and developed by: [your names here]
+Designed and developed by: [Robert Fontan, Zion Mateo]
 
 🔗 Link to deployed app:
 
 ## About
 
 ### Description and Purpose
 
-[text goes here]
-
+The purpose of this app is to create a utility app that helps prospective IT workers figure out what they need to learn and accomplish in order to be an effective candidate for a given job title. The idea is to use OpenAI and web-scraping to generate technical interview questions and behavioral exercises to maximize the preparation of our user.
 ### Inspiration
 
-[text goes here]
+Inspiration comes from our own daily life, where we often try to aggregate resources that help us prepare for online assessments and interviews for a specific job.
 
 ## Tech Stack
 
-Frontend:
+Frontend: 
+React, Bootstrap
 
 Backend:
+Railway, PostgreSQL, Express, Node.js
 
 ## Features
 
-### [Name of Feature 1]
-
-[short description goes here]
+### Technical + Behavioral Question Generation
 
+The main core feature of this app. We want this app to generate technical questions for the user, as well as behavioral questions. The backbone of this operation will come from OpenAI's prompt API, however we are also considering of web-scraping websites such as Glassdoor for more technical/behavioral questions.
 [gif goes here]
 
-### [Name of Feature 2]
-
-[short description goes here]
+### General Question library
 
+We could harbor a vast collection of technical and behavioral questions that are tailored for various IT roles. Within it, we should allow for filtering and searching options based on job roles, technologies, or difficulty levels.
 [gif goes here]
 
-### [Name of Feature 3]
-
-[short description goes here]
+### AI-Powered Feedback
 
+If we have behavioral questions or even for technical questions, we could have an AI-Chat bot where when users record their answers, the bot can give real-time, responsive feedback.
 [gif goes here]
 
-### [ADDITIONAL FEATURES GO HERE - ADD ALL FEATURES HERE IN THE FORMAT ABOVE; you will check these off and add gifs as you complete them]
+### [ADDITIONAL FEATURES GO HERE - ADD ALL FEATURES HERE IN THE FORMAT ABOVE; you will check these off and add gifs as you complete them] ✅✅✅
 
 ## Installation Instructions
 

diff --git a/client/.eslintrc.cjs b/client/.eslintrc.cjs
@@ -0,0 +1,20 @@
+module.exports = {
+  root: true,
+  env: { browser: true, es2020: true },
+  extends: [
+    'eslint:recommended',
+    'plugin:react/recommended',
+    'plugin:react/jsx-runtime',
+    'plugin:react-hooks/recommended',
+  ],
+  ignorePatterns: ['dist', '.eslintrc.cjs'],
+  parserOptions: { ecmaVersion: 'latest', sourceType: 'module' },
+  settings: { react: { version: '18.2' } },
+  plugins: ['react-refresh'],
+  rules: {
+    'react-refresh/only-export-components': [
+      'warn',
+      { allowConstantExport: true },
+    ],
+  },
+}
diff --git a/client/README.md b/client/README.md
@@ -0,0 +1,8 @@
+# React + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
diff --git a/client/index.html b/client/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en" data-bs-theme="dark">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg"/>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + React</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.jsx"></script>
+  </body>
+</html>