https://github.com/tycrek/cheek

ass cheek. a serverless ShareX server.
https://github.com/tycrek/cheek

cloudflare hono serverless sharex sharex-server

Last synced: 3 months ago
JSON representation

ass cheek. a serverless ShareX server.

• Host: GitHub
• URL: https://github.com/tycrek/cheek
• Owner: tycrek
• License: isc
• Created: 2023-06-18T20:06:50.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-07-12T17:25:01.000Z (7 months ago)
• Last Synced: 2024-10-25T10:37:40.000Z (3 months ago)
• Topics: cloudflare, hono, serverless, sharex, sharex-server
• Language: TypeScript
• Homepage:
• Size: 383 KB
• Stars: 7
• Watchers: 2
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


😝 cheek

===

*ass cheek. a serverless ShareX server.*



# What??

**cheek** is similar to my other project, [ass](https://github.com/tycrek/ass). The biggest difference is that cheek is runs on Cloudflare's **serverless platform**, where ass uses traditional hosting with Node.js.

# Roadmap

- [x] Upload (supports ShareX currently)

- [x] Fetch/view image

- [x] Embed features for Discord

- [ ] Delete image

- [ ] Multi-user

# Usage

You will be deploying to Cloudflare [Pages]. Before you begin, make sure you have setup:

| Bind type | Bind name |

| :-------: | --------- |

| [KV] | `cheekkv` |

| [R2] | `cheekstore` |

[Pages]: https://pages.cloudflare.com/

[KV]: https://www.cloudflare.com/en-ca/developer-platform/workers-kv/

[R2]: https://www.cloudflare.com/en-ca/developer-platform/r2/

Run these commands to deploy:

```bash

git clone https://github.com/tycrek/cheek.git

cd cheek

npm i

npm run publish

```

Navigate to your deployment domain to view the setup page. Enter a token that you will use for uploading.

## Uploads

*Docs WIP*

## Discord Embeds

Discord embeds can be configured by setting the following HTTP Headers. **Title** is required for embeds to work.

- **`x-cheek-title`**

- `x-cheek-description`

- `x-cheek-author-name`

- `x-cheek-author-url`

- `x-cheek-provider-name`

- `x-cheek-provider-url`

- `x-cheek-color`

#### These docs are a work-in-progress