-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1fe2e91
commit c4f8381
Showing
1 changed file
with
5 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Blog Webhook API | ||
# Ghost Webhook API | ||
|
||
![Python](https://img.shields.io/badge/Python-^3.10-blue.svg?logo=python&longCache=true&logoColor=white&colorB=5e81ac&style=flat-square&colorA=4c566a) | ||
![FastAPI](https://img.shields.io/badge/FastAPI-^v0.89.1-blue.svg?longCache=true&logo=fastapi&style=flat-square&logoColor=white&colorB=5e81ac&colorA=4c566a) | ||
|
@@ -14,15 +14,15 @@ | |
|
||
![Blog Webhook API](./.github/[email protected]?raw=true) | ||
|
||
Webhook-driven API to make maintaining blogs easier. Dynamically handles optimizations including image compression, content sanitation, alerting, and feature enablement via data aggregate (suggested searches, trending posts, etc) | ||
Standalone API to compliment Ghost blogs. Accepts Ghost webhook events tiggers & executes task to optimize content and serve new features. Handles optimizations including image compression, content sanitation, alerting, and feature enablement via data aggregate (suggested searches, trending posts, etc) | ||
|
||
## Installation | ||
|
||
Get up and running with `make deploy`: | ||
|
||
```shell | ||
git clone https://github.com/toddbirchard/blog-webhook-api.git | ||
cd blog-webhook-api | ||
git clone https://github.com/toddbirchard/ghost-webhook-api.git | ||
cd ghost-webhook-api | ||
make deploy | ||
``` | ||
|
||
|
@@ -85,4 +85,4 @@ Insight to scenarios where Authors likely need assistance. | |
Notifications when user activity is made on project repos. | ||
|
||
* **POST** `/github/pr/`: Trigger SMS notification when contributors open a Github PR in a specified Github org. | ||
* **POST** `/github/issue/`: Trigger SMS notification when contributors open a Github issue in a specified Github org. | ||
* **POST** `/github/issue/`: Trigger SMS notification when contributors open a Github issue in a specified Github org. |