Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wanderer-moe/api
📦 The API for https://wanderer.moe/ — (v2 branch) created using Cloudflare Workers, R2, DO, Hono, Lucia Auth, Drizzle, Turso, Scalar & Resend
https://github.com/wanderer-moe/api
authentication cloudflare cloudflare-kv cloudflare-r2 cloudflare-workers drizzle durable-objects hono lucia-auth r2 resend turso typescript
Last synced: 5 days ago
JSON representation
📦 The API for https://wanderer.moe/ — (v2 branch) created using Cloudflare Workers, R2, DO, Hono, Lucia Auth, Drizzle, Turso, Scalar & Resend
- Host: GitHub
- URL: https://github.com/wanderer-moe/api
- Owner: wanderer-moe
- License: gpl-3.0
- Created: 2022-07-10T21:22:46.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-16T18:52:32.000Z (6 days ago)
- Last Synced: 2024-12-17T04:05:29.914Z (5 days ago)
- Topics: authentication, cloudflare, cloudflare-kv, cloudflare-r2, cloudflare-workers, drizzle, durable-objects, hono, lucia-auth, r2, resend, turso, typescript
- Language: TypeScript
- Homepage: https://api.wanderer.moe
- Size: 1.86 MB
- Stars: 74
- Watchers: 1
- Forks: 2
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
![Banner]
![Quality] ![API Response] ![CDN Response]
Source code for the API powering [**wanderer.moe**](https://wanderer.moe) — using **Cloudflare Workers** with **R2 Storage** for the CDN.
---
## Usage
#### Wrangler
Configuration is in `wrangler.toml` - this includes the R2 Bucket.
- Run `wrangler dev` to preview locally.
- Run `wrangler deploy` to publish to Cloudflare Workers.
#### Actions
- There is a GitHub Action that automatically deploys to Cloudflare Workers on every push to `main` — you can find it in `.github/workflows/deploy.yml`.
- If you're using Github Actions, you will have to setup a secret with a Cloudflare API token. You can generate the API token [here][Cloudflare API Token] — use the `Edit Cloudflare Workers` template.
## API Reference
### Games
#### Get all games
```http
GET api.wanderer.moe/games
```
#### Get game data
```http
GET api.wanderer.moe/game/${gameId}
```
| Parameter | Type | Description |
| :-------- | :------- | :---------------------------------- |
| `gameId` | `string` | **Required** — game to get data for |
#### Get a game's asset data
```http
GET api.wanderer.moe/game/${gameId}/${asset}
```
| Parameter | Type | Description |
| :-------- | :------- | :----------------------------------- |
| `gameId` | `string` | **Required** — game to get data for |
| `asset` | `string` | **Required** — asset to get data for |
## Authors
- [@dromzeh][Dromzeh]
## License
[api.wanderer.moe][api.wanderer.moe] is licensed under the [GNU Affero General Public License v3.0][License] - **You must state all significant changes made to the original software, make the source code available to the public with credit to the original author, original source, and use the same license.**
[Banner]: https://files.catbox.moe/qa3eus.svg
[API Status]: https://status.wanderer.moe/history/api
[CDN Status]: https://status.wanderer.moe/history/cdn
[API Response]: https://img.shields.io/endpoint?label=API%20Response&style=for-the-badge&url=https%3A%2F%2Fraw.githubusercontent.com%2Fwanderer-moe%2Fstatus%2FHEAD%2Fapi%2Fapi%2Fresponse-time.json
[CDN Response]: https://img.shields.io/endpoint?label=CDN%20Response&style=for-the-badge&url=https%3A%2F%2Fraw.githubusercontent.com%2Fwanderer-moe%2Fstatus%2FHEAD%2Fapi%2Fcdn%2Fresponse-time.json
[Quality]: https://img.shields.io/codefactor/grade/github/wanderer-moe/api?label=quality&style=for-the-badge
[Cloudflare API Token]: https://dash.cloudflare.com/profile/api-tokens
[Dromzeh]: https://github.com/dromzeh
[api.wanderer.moe]: https://api.wanderer.moe
[License]: LICENSE