job-board

command module
v0.0.0-...-80e8cda Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 15, 2023 License: BSD-3-Clause Imports: 22 Imported by: 0

README

Job Board

This is the first Go job board with no recruiters & clear salary ranges.

  • Clear salary range in each job description
  • No third party recruiters (apply directly to companies)
  • All jobs are manually vetted and reviewed
  • Browse salary trends by region
  • Browse companies hiring Go engineers and using Go in production
  • Browse Go developers
  • Weekly Job Newsletter Digest
  • Open Source
  • Filter by minimum Salary
  • The site home page weights under 250kb (188kb uncompressed)

Tech Stack

Local Development Mode - Setup Guide

It's possible to setup a blank instance of this job board locally. This is a local development mode and it's different from the way the app runs in production. In this scenario the app runs on a minimal database containing mock data. The app has reduced functionality when ran in local development mode. It's not possible to send emails or connect to third party services, like Twitter, Telegram and FX APIs. It's still possible to run and test the app but with limited functionality.

Requirements

These are basic requirements with the respective versions have been tested to work locally on MacOS. The same should apply both on Linux and WSL/Windows.

  • Bash 3.2.x or higher
  • Docker 20.10.x or higher
  • Go 1.15.x or higher

Dependencies

  • PostgreSQL instance mocked using local Docker container, with local schema and fixtures
  • Sparkpost Mail emails are sent using http requests through Sparkpost APIs. This is not enabled in local development mode.
  • Telegram API telegram updates are sent through the Job Board official Telegram channel. This is not enabled in local development mode.
  • Twitter API twitter updates are sent through the Job Board official page. This is not enabled in local development mode.
  • FX API a minimal set of Foreign Currency Exchange data is kept up-to-date to filter out salary ranges. This is not enabled in local development mode.

Setup Guide

The only thing that needs to be setup in order for the app to run is the PostgreSQL database instance. Please run the following command in order to setup your local database instance.

./setup-database.sh

Once this command is successful you can now start the application

./run-local-webserver.sh

Test Cron-Jobs Locally

There are a few cron-jobs that are triggered on a schedule, these are scheduled externally via custom http calls to the website. You can see all available cron-jobs by searching for all routes that start with /x/task/.

In order to test a cron-job you can just make the following http request

curl -v -H 'x-machine-token: <machine-token>' -X POST http://localhost:9876/x/task/<task-name>

You can find the under your local environment variable configuration, in the MACHINE_TOKEN environment variable.

Telegram Group OSS discussions

https://t.me/+VloraT7W9yA1YTI8

Feedback?

Feel free to open an issue on GitHub

License

This source code is licensed under BSD 3-Clause License

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
job
seo

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL