dviramontes/gh-release-monitor

gh-release-monitor

A restful API project for monitoring github releases

Project Layout

{root}

dev
└── user.clj            # utilities for repl driven development (see make repl)
src
└── api
    ├── db.clj          # DB config details
    ├── cron.clj        # routine-like job for refreshing releases in db
    ├── handlers.clj    # handlers that interact with the DB     
    ├── github.clj      # functions for interacting with github API
    ├── jdbc.clj        # support for various SQL <> Clojure data types  
    ├── main.clj        # app's main entry and middleware configurations       
    └── routes.clj      # API routes

• For a list of endpoints supported by this API refer to this doc. Also available via swagger at http://localhost:4000/
• For this project's KANBAN board follow this link.

Requirements

• Java8+
• Clojure
• Docker

Setup

config setup

1. touch secrets.edn (.gitignored)
2. add your github token in this format

{:github-token "top-secret"}  ;; used for GitHub API requests

Development

1. make up # spins up docker-compose
2. make migrations # runs migrations up
3. make run # runs code locally

Running with REPL

1. make repl # runs nrepl
2. API will now start serving traffic on localhost:4000
3. evaluate (reset) after changing code
4. evaluate (halt) to stop the server or simply CTRL + c to end the process

Additional dev tasks

• make lint # lints code via clj-kondo
• make format # formats code via cljfmt
• make repl # spins up rebel-readline

Production

• make jar

Test

• make test # runs integration tests