Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/charlestaylor7/octo-events

API for Github Events
https://github.com/charlestaylor7/octo-events

api express github knex nodejs postgres typescript webhook

Last synced: about 18 hours ago
JSON representation

API for Github Events

Awesome Lists containing this project

README 

        
# Octo Events

Octo events is an API server built with [Fastify](https://fastify.dev/), [Typescript](https://www.typescriptlang.org/) & [Prisma](https://www.prisma.io/).

It receives webhook events from github issues, and then makes those events available to read later.



Consumers of the api can get a list of events that occurred on this repo by calling the endpoint `/issues/:issueNumber/events`. 



Octo Events is live and deployed on [fly.io](https://fly.io)

So to see a sample query in action, just visit this url: https://octo-events.fly.dev/issues/3/events



## CI / CD

This project makes use of Continuous Integration & Continuous Delivery via Github Actions.

Every push to the `main` branch will cause the testsuite and typescript verification to run. If both those pass, then the application is deployed to https://octo-events.fly.dev. You can see the workflow `.github/workflows/publish.yml` for the nitty gritty details.



## Docker

There is a provided Dockerfile intended for production deployment, but not local development. 

Currently the application is hosted on fly.io, for ease of setup. But this project could be deployed to other cloud providers with relative ease, because it is already running in a docker container.



## Local Development Setup 

1. You need postgres installed, with a superuser named "postgres". Sample instructions for Mac:

```sh

brew install postgresql@14

createuser -s postgres

```



4. You need to install yarn (classic):

```sh

npm install --global yarn

```



4. Install dependencies:

```sh

yarn

```



4. Setup your `.env` file:



`.env` is in the .gitignore file and should stay that way. To make your .env file, copy the contents of `.env.dev-sample` over to `.env` and fill in the values.

`

- `PORT`: Fill in whichever port you'd like to run your dev server from.

- `DATABASE_URL`: The database connection string. Can stay as-is.

- `GITHUB_WEBHOOK_SECRET`: Set this value to a secure random string. I generarated mine by running `npx uuid`. 



5. Setup your webhook:



Pick a github repo to watch and create a webhook for it. The Github docs outline the process well. When you are prompted for a secure secret, use the same value generated for `GITHUB_WEBHOOK_SECRET`.

For the payload url, you'll probably want to use ngrok and provide the url that tool gives you. 



- Github Webhooks: https://developer.github.com/webhooks/creating/.

- Ngrok: https://ngrok.com/



## Development Commands

Start the dev server:

`yarn dev`



Format code:

`yarn format`



Run tests:

`yarn test`



Verify typescript types:

`yarn typecheck`



I personally use [mprocs](https://github.com/pvolok/mprocs) to manage running multiple of these commands together.



## Migrations

Database migrations are managed via [Prisma](https://www.prisma.io/docs/concepts/components/prisma-migrate). 



To migrate the database, you'll need to edit the `prisma/schema.prisma` file



Then you can apply those changes by running `yarn migrate`. This will immediately update your local dev database, and serialize your changes as a new sql migration in the `prisma/migrations` folder.

You need to commit the automatically generated `migration.sql` file alongside your changes to the schema.prism file. That way, the production database will be able to migrate properly.