Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gifflet/api-cloudflare-worker
A Cloudflare Worker-based API for retrieving GitHub user statistics
https://github.com/gifflet/api-cloudflare-worker
api cloudflare github hono typescript workers-kv
Last synced: about 2 months ago
JSON representation
A Cloudflare Worker-based API for retrieving GitHub user statistics
- Host: GitHub
- URL: https://github.com/gifflet/api-cloudflare-worker
- Owner: gifflet
- Created: 2024-11-15T04:27:05.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2024-11-15T04:52:14.000Z (about 2 months ago)
- Last Synced: 2024-11-15T05:27:17.088Z (about 2 months ago)
- Topics: api, cloudflare, github, hono, typescript, workers-kv
- Language: TypeScript
- Homepage:
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**API Cloudflare Worker**
=====================
**Table of Contents**
-----------------
1. [Overview 🚀](#overview-🚀)
2. [Features 🎉](#features-🎉)
3. [Getting Started 📊](#getting-started-📊)
4. [Usage 💻](#usage-💻)
5. [Configuration 🔧](#configuration-🔧)
6. [Wrangler Setup 📚](#wrangler-setup-📚)
**Overview 🚀**
------------
This project provides a simple API for retrieving GitHub user statistics, built using Cloudflare Workers and Hono. The API caches responses to reduce the number of requests made to the GitHub API.
**Features 🎉**
------------
* Retrieves GitHub user statistics, including repository information
* Caches responses to reduce the number of requests made to the GitHub API
* Built using Cloudflare Workers and Hono for high performance and scalability
**Getting Started 📊**
-------------------
### Prerequisites
* Node.js (version 14 or higher)
* npm (version 6 or higher)
* Cloudflare Workers CLI (version 1.0.0 or higher)
### Installation
1. Clone the repository: `git clone https://github.com/gifflet/api-cloudflare-worker`
2. Install dependencies: `npm install`
3. Configure the project: `cp wrangler.toml wrangler.toml.example` and update the `wrangler.toml` file with your Cloudflare API credentials
**Usage 💻**
---------
### API Endpoints
* `GET /:username`: Retrieves GitHub user statistics for the specified username
### Example Usage
* `curl https://your-worker-url.com/your-username`
**Configuration 🔧**
----------------
### Environment Variables
* `CACHE`: The name of the KV namespace used for caching responses
### Wrangler Configuration
* `wrangler.toml`: Configure the project with your Cloudflare API credentials and KV namespace settings
**Wrangler Setup 📚**
----------------------
### Create a new KV namespace
* `npx wrangler kv:namespace create `: Creates a new KV namespace for caching responses.
* Example: `npx wrangler kv:namespace create github-stats-api-cache`
### Configure the KV namespace
* `npx wrangler kv:namespace configure --binding `: Configures the KV namespace with a binding name.
* Example: `npx wrangler kv:namespace configure github-stats-api-cache --binding CACHE`
### Create a D1 Database
* `npx wrangler d1 create `: Creates a new D1 database.
* Example: `npx wrangler d1 create github-metrics`
### Create and Apply Migrations
1. Create a migration file:
* `npx wrangler d1 migrations create `
* Example: `npx wrangler d1 migrations create github_metrics create-tables`
2. Apply migrations to the remote database:
* `npx wrangler d1 migrations apply `: Applies all pending migrations to your database.
* Example: `npx wrangler d1 migrations apply github_metrics --remote`
> If you want to execute migrations locally (for development), you can use the following command:
* `npx wrangler d1 migrations apply --local`: Applies migrations to local D1 database.
* Example: `npx wrangler d1 migrations apply github_metrics --local`
### Query D1 Database
* `npx wrangler d1 execute --command ""`: Executes SQL commands on your D1 database.
* Example: `npx wrangler d1 execute github_metrics --command "SELECT * FROM github_metrics"`
You can also execute queries locally by adding the `--local` flag:
* Example: `npx wrangler d1 execute github_metrics --local --command "SELECT * FROM github_metrics"`