go-scraper

README

Go Scraper

Demo

• Staging
• Production
• Postman collection

Prerequisite

• Go - 1.15
• Node - 14.15.4
• Docker: check for the installation guide for your platform

Usage

Clone the repository

git clone git@github.com:nimblehq/git-template.git

Install development dependencies

This project uses the following dependencies:

• Bee - Bee CLI
• Forego - Foreman in Go

Install them by running:

  make install-dependencies

Run the Go application for development

  make dev

The application will be run on http://localhost:8080

Run tests

  make test

Deploy to Heroku with Terraform

Prerequisites

• Heroku CLI latest version
• Terraform

To deploy the application to Heroku with Terraform, we need to create the Heroku API Key first:

$ heroku authorizations:create --description <api key description>

And then, move to the deploy/heroku folder and run the following steps:

Step 1: Copy the variable file and update the variables

$ cp terraform.tfvars.sample terraform.tfvars

Step 2: Initialize Terraform

$ terraform init

Step 3: Generate an execution plan

$ terraform plan

Step 5: Execute the generated plan

$ terraform apply

Step 6: Build the application and push to heroku

You can check .github/workflows/deploy.yml workflow for more details

Make sure you set the following Github secrets before deploying the application:

DOCKER_TOKEN       # Docker token
HEROKU_API_KEY     # Heroku OAuth token
HEROKU_APP_PROD    # Heroku app name for production
HEROKU_APP_STAGING # Heroku app name for staging

About

This project is created to complete Web Certification Path using Go at Nimble