Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/sapphicmoe/status-worker

🌠 Display your current status to others with Cloudflare Workers!
https://github.com/sapphicmoe/status-worker

cloudflare cloudflare-worker cloudflare-workers hono honojs

Last synced: about 2 months ago
JSON representation

🌠 Display your current status to others with Cloudflare Workers!

Host: GitHub
URL: https://github.com/sapphicmoe/status-worker
Owner: SapphicMoe
License: mit
Created: 2024-01-05T10:05:24.000Z (12 months ago)
Default Branch: master
Last Pushed: 2024-01-10T21:52:31.000Z (12 months ago)
Last Synced: 2024-10-04T22:11:12.213Z (3 months ago)
Topics: cloudflare, cloudflare-worker, cloudflare-workers, hono, honojs
Language: TypeScript
Homepage:
Size: 25.4 KB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# status-worker

A simple service for Cloudflare Workers that allows you to display your current status to others with ease!

## Deploy

Wrangler 3 is required, though `pnpm` commands should automatically take care of that for you.

Run these commands in their respective order:

- `pnpm install`
- `pnpm addsecret`
- `pnpm createkv`
- `pnpm deploy`

To deploy to your Cloudflare Workers account, edit the entries in the `wrangler.toml` file.
Then, add a secret using `wrangler secret put STATUS_SECRET`, and deploy via `pnpm deploy`.

## Debugging

If you want to debug `status-worker`, you can run `pnpm dev`. This will summon a local instance of the project.

To change the secrets in the local instance, rename the `.dev.vars.example` file to `.dev.vars` and edit `STATUS_SECRET` to your custom defined secret.

## Usage

Once you deploy `status-worker` to Cloudflare Workers, it should be relatively straightforward to use the API.

### Creating a status

To create a status, send a `POST` request to `/` with the following options:

- `Authorization`: This is the secret you defined when running `pnpm addsecret`.
- `Content-Type`: `application/json`
- Body data:
- `title`: The title of your status.
- `body`: The content of your status.

For example:

```bash
lily@sapphic-angels:~$ curl -X POST \
-H "Authorization: mysecret" \
-H "Content-Type: application/json" \
-d '{"title": "Status title", "body": "Status content"}' \
https://status.example.com
```
```json
{
"message": "Successfully created a new status.",
"status": {
"id": "3c523f18-f20c-48df-acba-b330f11e66da",
"title": "Status title",
"body": "Status content",
"date": "2024-01-05T12:16:55.479Z"
}
}
```

**Note**:
On Windows, you might encounter issues with the command prompt interpreting certain characters. To resolve this, use double quotes around the JSON data. (ex. `"{\"title\": \"Status title\", \"body\": \"Status content\"}"`)

### Viewing a status

To view your latest status, send a `GET` request to `/`.

```bash
lily@sapphic-angels:~$ curl https://status.example.com/
```
```json
{
"status": {
"id": "3c523f18-f20c-48df-acba-b330f11e66da",
"title": "Status title",
"body": "Status content",
"date": "2024-01-05T12:16:55.479Z"
}
}
```

To view a specific status, send a `GET` request to that specific ID.

```bash
lily@sapphic-angels:~$ curl https://status.example.com/5250f13c-fa8a-458c-b09b-8523d86d5428
```
```json
{
"status": {
"id": "5250f13c-fa8a-458c-b09b-8523d86d5428",
"title": "Example",
"body": "test test",
"date": "2024-01-05T12:17:05.118Z"
}
}
```

To view all created statuses, send a `GET` request to `/list`.

```bash
lily@sapphic-angels:~$ curl https://status.example.com/list
```
```json
{
"statuses": [
{
"id": "3c523f18-f20c-48df-acba-b330f11e66da",
"title": "meow",
"body": "curl test 2",
"date": "2024-01-05T12:16:55.479Z"
},
{
"id": "b872946c-10d9-4942-8194-0ed65aaa420f",
"title": "meow",
"body": "curl test 3",
"date": "2024-01-05T12:22:01.292Z"
}
]
}
```

### Updating a status

To update a specific status, send a `PUT` request to that specific status ID.

```bash
lily@sapphic-angels:~$ curl -X PUT \
-H "Authorization: mysecret" \
-H "Content-Type: application/json" \
-d '{"title": "Updated status title", "body": "Updated status content"}' \
https://status.example.com/3c523f18-f20c-48df-acba-b330f11e66da
```
```json
{
"message": "Status updated successfully.",
"status": {
"id": "3c523f18-f20c-48df-acba-b330f11e66da",
"title": "Old status title",
"body": "Old status content",
"date": "2024-01-05T12:16:55.479Z"
}
}
```

### Deleting a status

To delete a specific status, send a `DELETE` request to that specific status ID.

```bash
lily@sapphic-angels:~$ curl -X DELETE \
-H "Authorization: mysecret" \
https://status.example.com/3c523f18-f20c-48df-acba-b330f11e66da
```
```json
{
"message": "Status deleted successfully.",
"status": {
"id": "3c523f18-f20c-48df-acba-b330f11e66da",
"title": "Status title",
"body": "Status content",
"date": "2024-01-05T12:16:55.479Z"
}
}
```

## Credits

Some of the code for this project has been borrowed from Erisa's **[worker-links](https://github.com/Erisa/worker-links)** project.

I encourage you to check it out!

## License