JoPilot

Overview

JoPilot is a web application designed to assist with job applications. It consists of three main components:

1. Backend API: A Flask-based API that serves data to the frontend.
2. Frontend: A React-based web application that interacts with the backend API.
3. JoPilot Extension: A browser extension that provides additional functionality related to job applications.

Setup Instructions

Prerequisites

• Python 3.x
• Node.js and npm
• A web browser (for testing the extension)

Backend API

1. Navigate to the backend directory:

   cd backend-api

2. Create a virtual environment:

   python -m venv venv

3. Activate the virtual environment:

   • On Windows:

     venv\Scripts\activate

   • On macOS/Linux:

     source venv/bin/activate

4. Install the required packages:

   pip install -r requirements.txt

5. Run the Flask application:

   python run.py

   The backend API will be available at http://localhost:5000.

Issues:

1. ImportError: cannot import name 'url_quote' from 'werkzeug.urls' when starting run.py

   pip install Flask==3.0.3

Frontend

1. Navigate to the frontend directory:

   cd frontend

2. Install the required packages:

   npm install

3. Run Development Server:

   npm run dev

JoPilot Extension

1. Navigate to the extension directory:

   cd joPilot_extension

2. Load the extension in your browser:

   • Open your browser and navigate to the extensions page.
   • Enable "Developer mode".
   • Click "Load unpacked" and select the joPilot_extension directory.

   The extension will be available in your browser.

Testing

To test the entire setup:

1. Start the backend API.
2. Start the frontend application.
3. Load the JoPilot extension in your browser.
4. Open the frontend application in your browser and interact with it to see data fetched from the backend API.
5. Use the JoPilot extension to test its functionality.

Overview

JoPilot is a web application designed to assist with job applications. It consists of three main components:

1. Backend API: A Flask-based API that serves data to the frontend.
2. Frontend: A React-based web application that interacts with the backend API.
3. JoPilot Extension: A browser extension that provides additional functionality related to job applications.

Setup Instructions

Prerequisites

• Python 3.x
• Node.js and npm
• A web browser (for testing the extension)

Backend API

1. Navigate to the backend directory:

   cd backend-api

2. Create a virtual environment:

   python -m venv venv

3. Activate the virtual environment:

   • On Windows:

     venv\Scripts\activate

   • On macOS/Linux:

     source venv/bin/activate

4. Install the required packages:

   pip install -r requirements.txt

5. Run the Flask application:

   python run.py

   The backend API will be available at http://localhost:5000.

Issues:

1. ImportError: cannot import name 'url_quote' from 'werkzeug.urls' when starting run.py

   pip install Flask==3.0.3

Frontend

1. Navigate to the frontend directory:

   cd frontend

2. Install the required packages:

   npm install

3. Run Development Server:

   npm run dev

JoPilot Extension

1. Navigate to the extension directory:

   cd joPilot_extension

2. Load the extension in your browser:

   • Open your browser and navigate to the extensions page.
   • Enable "Developer mode".
   • Click "Load unpacked" and select the joPilot_extension directory.

   The extension will be available in your browser.

Project Structure

Backend API

• backend-api/app/__init__.py: Initializes the Flask application and sets up the routes.
• backend-api/app/routes.py: Defines the API endpoints.
• backend-api/app/models.py: Contains data models (currently a sample User model).
• backend-api/requirements.txt: Lists the Python dependencies.
• backend-api/run.py: Entry point to run the Flask application.

Frontend

• frontend/src/App.js: Main React component.
• frontend/src/index.js: Entry point for the React application.
• frontend/public/index.html: HTML template for the React application.
• frontend/package.json: Lists the JavaScript dependencies and scripts.

JoPilot Extension

• joPilot_extension/index.html: HTML file for the extension popup.
• joPilot_extension/manifest.json: Configuration file for the extension.
• joPilot_extension/popup.js: JavaScript file for the extension's functionality.
• joPilot_extension/style.css: CSS file for the extension's styling.

Testing

To test the entire setup:

1. Start the backend API.
2. Start the frontend application.
3. Load the JoPilot extension in your browser.
4. Open the frontend application in your browser and interact with it to see data fetched from the backend API.
5. Use the JoPilot extension to test its functionality.