README.md

CompanyHunter 🎯

Find your dream job with our advanced multi-API job search platform

✨ Features

Click to expand features

Feature	Description	Status
🔄 Multi-API Integration	Aggregates job listings from Adzuna, Reed, Indeed, and more	✅
🗺️ Interactive Map	Visualize job locations using Google Maps	✅
🔍 Advanced Filtering	Filter by job category, job type, and distance	✅
🎨 Modern UI	Sleek design with animations powered by Framer Motion	✅
🏢 Company Info	View detailed company information and metadata	✅
📱 Responsive Design	Works on desktop and mobile devices	✅

🚀 Technology Stack

Frontend

Technology	Version	Purpose
React	18.0+	UI Framework
Framer Motion	Latest	Animations
Google Maps API	Latest	Map Integration
Styled Components	Latest	CSS-in-JS

Backend

Technology	Version	Purpose
Python	3.9+	Backend Language
Flask	2.0+	Web Framework
aiohttp	Latest	Async HTTP Client
SQLAlchemy	Latest	Database ORM

📋 Prerequisites

System Requirements

• Node.js (v14+)
• Python (v3.9+)
• API keys for the services:
  • Google Maps API key
  • Adzuna API credentials
  • Reed API key (optional)
  • Indeed Publisher ID (optional)

🔧 Installation

1️⃣ Clone the repository

git clone https://github.com/yourusername/CompanyHunter.git
cd CompanyHunter

2️⃣ Backend Setup

cd server
pip install -r requirements.txt

# Create .env file with your API keys
touch .env

Backend Environment Variables

# Required
GOOGLE_MAPS_API_KEY=your_google_maps_api_key
ADZUNA_APP_ID=your_adzuna_app_id
ADZUNA_API_KEY=your_adzuna_api_key

# Optional
REED_API_KEY=your_reed_api_key
INDEED_PUBLISHER_ID=your_indeed_publisher_id

3️⃣ Frontend Setup

cd client
npm install

# Create .env file for frontend
touch .env

Frontend Environment Variables

REACT_APP_GOOGLE_MAPS_API_KEY=your_google_maps_api_key
REACT_APP_API_URL=http://localhost:5000

🚀 Running the Application

Backend Server

cd server
python app.py

Frontend Development Server

cd client
npm start

The application will be available at http://localhost:3000

📖 How to Use

User Guide

1. Search for Jobs 🔍

   • Enter a location (city, address, or postal code)
   • Set a search radius using the slider
   • Click "Search Jobs"

2. Filter Results ⚙️

   • Use the Filter Options panel to filter by job category and job type
   • Selected filters will be displayed as tags

3. View Job Details 📄

   • Click on a job card to view detailed information
   • Job location is displayed on the map

4. Save Favorites ⭐

   • Click the "Save" button on a job to save it to your favorites

📁 Project Structure

CompanyHunter/
├── client/                  # React frontend
│   ├── public/              # Static files
│   └── src/                 # Source files
│       ├── components/      # React components
│       └── App.js           # Main application component
│
└── server/                  # Flask backend
    ├── api_connectors/      # API connector modules
    │   ├── adzuna_connector.py
    │   ├── reed_connector.py
    │   ├── indeed_connector.py
    │   ├── google_jobs_connector.py
    │   └── aggregator.py    # Job aggregation logic
    ├── app.py               # Flask application
    └── requirements.txt     # Python dependencies

🔜 Future Enhancements

Planned Features

• User authentication and saved job management
• Email notifications for new job matches
• Enhanced company profiles with reviews and ratings
• Salary insights and comparisons
• Application tracking system
• AI-powered job matching
• Resume builder and optimization
• Interview preparation tools

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgements

Technology	Link
React	reactjs.org
Flask	flask.palletsprojects.com
Google Maps	developers.google.com/maps
Adzuna API	developer.adzuna.com
Reed API	reed.co.uk/developers
Indeed API	developer.indeed.com
Framer Motion	framer.com/motion/

---

Made with ❤️ by Your Name