job-search

My Job Search Tool

Sends daily new jobs update on Telegram.
View Demo

Table of Contents

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

About The Project

An API for that searches provided job sites for posted jobs.

Given requirements

• A user can search given job sites for posted jobs by using their urls

Built With

• Go
• Google CSE

API Swagger Docs

https://job-searcher.onrender.com/docs

Endpoints:

Search for jobs

POST /api/v1/search

Example request body:

{
    "jobSites": ["lever.co", "greenhouse.io", "app.dover.com", "jobs.ashbyhq.com"],
    "jobTitles": ["engineer", "developer", "remote"],
    "ignore": ["front end", "senior", "lead", "full stack", "react", "staff"],
    "include": ["golang"],
    "from": 2
}

Required fields: jobSites, jobTitles, ignore, include, from

Home

GET /

HTTP Response Status codes:

• 200 for OK
• 400 for Bad requests
• 500 for Internal Server Error

(back to top)

Getting Started

Prerequisites

• To run this project, make sure you have Go installed on your machine.

Installation

1. Clone the repo

   git clone https://github.com/rafmme/job-search.git

2. Rename the .env.example file to .env and populate the variables with the right data

      PORT=6000
      CSE_KEY=AIza
      CX=c2b
      MAIL_HOST=smtp.cvcv.com
      [email protected]
      MAIL_HOST_PASSWORD=34335555
      [email protected]
      EXT_MAIL_SERVICE_URL=http://localhost:1111/api/v1/mailer
      TG_ID=12345678
      TELEGRAM_APITOKEN=68hgh9
      SERAPI_KEY=ty7799
   

3. Run this command make run to start up the application.

(back to top)

Usage

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)