docs: initialize project documentation, AI guidelines, and logging standards
This commit is contained in:
@@ -0,0 +1,66 @@
|
||||
# Hireme (GJCC)
|
||||
|
||||
**Hireme (Google Job Command Center)** is a high-performance, single-binary job application and tracking command center written in Go.
|
||||
|
||||
It completely automates the job search workflow by crawling job boards, analyzing job descriptions against your profile using Large Language Models (LLMs), and presenting a sleek, HTMX-powered UI to review, save, and track your applications.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Automated Crawling:** Background worker pools discover and fetch job listings from targets (e.g., Google Jobs).
|
||||
- **LLM Job Analysis:** Integrates with LLMs (Mock, Gemini, Claude) to score jobs based on your qualifications, identify missing skills, and provide resume tailoring suggestions.
|
||||
- **Smart Filtering:** Multi-stage filtering pipeline (Hard Keywords + Scoring Weights) configured via YAML to automatically reject unqualified jobs before expensive LLM calls.
|
||||
- **Sleek UI:** A responsive, dark-mode dashboard built with Go Templates, HTMX, and Tailwind CSS.
|
||||
- **Pipeline Management:** An interactive Apply Table to move jobs through your pipeline (Saved ▶ Applied ▶ Interview ▶ Offer).
|
||||
- **Single Binary & SQLite:** Everything is packaged into a single Go binary using a local SQLite database (WAL mode enabled) for zero-dependency deployment.
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Go 1.26+
|
||||
- `make`
|
||||
|
||||
### Installation
|
||||
|
||||
1. **Clone the repository:**
|
||||
|
||||
```bash
|
||||
git clone https://github.com/hireme/hireme.git
|
||||
cd hireme
|
||||
```
|
||||
|
||||
2. **Configure Data & Filters:**
|
||||
Copy the example configurations and adjust them:
|
||||
- `data/config/targets.yaml`: Setup crawler targets.
|
||||
- `data/config/filters.yaml`: Setup hard keywords and scoring weights.
|
||||
|
||||
3. **Set Environment Variables:**
|
||||
|
||||
```bash
|
||||
export LOG_LEVEL=debug
|
||||
export GEMINI_API_KEY="your_api_key" # If using Gemini LLM
|
||||
```
|
||||
|
||||
4. **Build and Run:**
|
||||
|
||||
```bash
|
||||
make clean
|
||||
make run
|
||||
```
|
||||
|
||||
5. **Access the UI:**
|
||||
Open your browser and navigate to [http://localhost:8080](http://localhost:8080).
|
||||
|
||||
## Commands
|
||||
|
||||
- `make build`: Builds the `hireme` binary into `build/`.
|
||||
- `make run`: Builds and runs the binary.
|
||||
- `make clean`: Removes the build binary and test databases.
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please review the documentation in the `docs/` folder to understand the architecture and UI guidelines before submitting pull requests.
|
||||
|
||||
## License
|
||||
|
||||
MIT License.
|
||||
Reference in New Issue
Block a user