Build Resumes Until Hired

Tailor your resumes and cover letter for a specific job

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributors

About The Project

Build Resumes Until Hired is an intelligent web application designed to help job software developers tailor their resumes and cover letters for specific job postings. By leveraging automation and customization, the platform helps optimizes application documents to increase the chances of landing interviews.

(back to top)

Built With

• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

These are the things required to run a local version of the app

• npm

• Docker (for easiest setup)

• python 3.x

• MongoDb (If running without docker)

Installation

1. Acquire tokens and a valid OpenAI API Key at OpenAI's API.

2. Clone the repo

3. Install NPM packages

   cd persentationLayer
   cd react-app
   npm install

4. Enter your backend API in app.js

   localStorage.setItem("url", "localhost:5000");

5. go to backendLayer dir

   cd backendLayer

6. create .env file to host API Key and other info. This format:

    GPT_API_KEY = "your GPT API Key"
    EMAIL_HASH_KEY = "createHashKeyHere...a;ldkfjapeif" 
    MONGO_URI="mongodb://rootuser:rootpassword@mongodb:27017/ProjDBExample?authSource=admin"
    MONGO_USER=rootuser
    MONGO_PASSWORD=rootpassword
    MONGO_DATABASE=ProjDBExample
   

(back to top)

Running Application

Now that you have installed everything these are the steps to run the app.

1. Be in the backendLayer dir. This will launch the entire backend. For info on ports used check the dockerfile and docker-compose file

   cd backenLayer

2. Start docker engine via cmd or docker desktop(just open app)

3. have latest .env file in backendLayer dir

4. Build and lauch containers:

   docker-compose up --build -d
   

To stop containers: docker-compose down
To stop docker engine: stop docker

5. Navigate to the persentationLayer react app dir

   cd persentationLayer
   cd react-app

6. build and run the npm run build

   npm install -g serve
   npm run build
   serve -s build

7. click on the localhost link to view the website

The app should now be fully running. Website is on localhost:3000 which is connected to the backend API container on localhost:5000

(back to top)

Documentation

• Backend API and AWS deployment documentation is on the backendLayer directory README.md file
• Frontend website documentation is on the presentationLayer directory README.md file

Contributors:

Rodolfo Gil DevOps & Backend Developer Management Team	Adam Yuen Fullstack Developer Management Team	Odin Fox Documentation Frontend Developer
Fahmi Sardar Frontend Developer	Alexander Lai Frontend Developer	Zaid Shaikh Fullstack Developer Management Team