Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/willnilges/cursed-status-page

A simple status page webserver that you control using Slack
https://github.com/willnilges/cursed-status-page

Last synced: about 1 month ago
JSON representation

A simple status page webserver that you control using Slack

Host: GitHub
URL: https://github.com/willnilges/cursed-status-page
Owner: WillNilges
License: gpl-2.0
Created: 2023-10-11T23:55:08.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-01-15T16:17:57.000Z (about 1 year ago)
Last Synced: 2024-11-05T13:11:36.633Z (3 months ago)
Language: Go
Size: 174 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 16
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# cursed-status-page
A simple status page webserver that you control using Slack

Ugh

![Static Badge](https://img.shields.io/badge/i_should_stop-writing_go-blue)
[![Docker](https://img.shields.io/badge/docker-hub-cyan)](https://hub.docker.com/repository/docker/willnilges/cursed-status-page/general)
[![Publish Docker Image](https://github.com/WillNilges/cursed-status-page/actions/workflows/to_docker_hub.yaml/badge.svg)](https://github.com/WillNilges/cursed-status-page/actions/workflows/to_docker_hub.yaml)
[![Deploy NYC Mesh Status Page](https://github.com/WillNilges/cursed-status-page/actions/workflows/deploy_to_nycmesh_status.yaml/badge.svg)](https://github.com/WillNilges/cursed-status-page/actions/workflows/deploy_to_nycmesh_status.yaml)

## Usage
Ping `@Cursed Status Page` in the `#status-page` channel with your status update, and then react to it with 🟢, 🟡, or 🔴 to turn it green, yellow, or red respectively. Pin the message in Slack to pin the message on the channel.

## Setup

### Slack Bot

A manifest file is included with this repo.

Go to https://api.slack.com/apps and click, "Create New App", then upload
`slack-manifest.yaml` and update the URLs to point at wherever you host
your page.

### Setup (Development)

Clone this repo

```
git clone https://github.com/willnilges/cursed-status-page
```

Fill out the .env.sample

```
cp .env.sample .env
vim .env # Use your favorite editor
```

Build and Run

```
go run .
```

To serve this app, I use [ngrok](https://ngrok.com/)

```
ngrok http --domain --host-header=rewrite localhost:8080
```

### Setup (Production)

This repo has a Dockerfile you can use

Clone this repo

```
git clone https://github.com/willnilges/cursed-status-page
```

Fill out the .env.sample

```
cp .env.sample .env
vim .env # Use your favorite editor
```

Build and Run

```
docker build . --tag cursed-status-page
docker run --rm --env-file .env -p 8080:8080 cursed-status-page
```