HackRadar API

HackRadar is a FastAPI-based API that collects hackathon data from platforms like MLH, Devpost, and Devfolio, storing everything in a PostgreSQL database. It provides endpoints for upcoming hackathons and can be deployed easily with Docker.

🚀 Features

• Scrapers for multiple hackathon platforms.
• REST API built with FastAPI.
• Uses PostgreSQL as the primary database.
• Automated scraping using background tasks or scheduled jobs.
• Dockerized setup for easy deployment.

⚡ Quick Start (Docker)

Run the following commands to start everything with Docker and PostgreSQL:

docker compose build
docker compose up -d

Access API at: http://localhost:8000/docs

🛠 Local Setup

1. Clone the repository:

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

2. Install dependencies (using uv):

   uv pip install -e .

3. Set up PostgreSQL: Ensure you have PostgreSQL running locally. Update the .env file with your database connection details.

4. Initialize the database:

   python -m backend.init_db

5. Run the scrapers to fetch initial data:

   python -m tasks.fetch_and_store

6. Start the FastAPI server:

   uvicorn backend.main:app --reload

7. Open the interactive API docs at: http://localhost:8000/docs

⚙️ Environment Variables

Create a .env file in the root directory:

DATABASE_URL=postgresql://hackuser:hackpass@db:5432/hackradar
SCRAPE_ON_START=1

🤝 Contributing

Contributions are welcome! Please check the Contributing Guide before submitting pull requests.

---