Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/5ouma/reproxy
🚚 Deliver any files in the GitHub repository
https://github.com/5ouma/reproxy
curl deno file github hono install jsr oneliner redirect repository reproxy typescript
Last synced: 3 months ago
JSON representation
🚚 Deliver any files in the GitHub repository
- Host: GitHub
- URL: https://github.com/5ouma/reproxy
- Owner: 5ouma
- License: mit
- Created: 2024-06-04T13:39:57.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-10-01T00:38:01.000Z (3 months ago)
- Last Synced: 2024-10-01T02:40:15.720Z (3 months ago)
- Topics: curl, deno, file, github, hono, install, jsr, oneliner, redirect, repository, reproxy, typescript
- Language: TypeScript
- Homepage: https://jsr.io/@5ouma/reproxy
- Size: 129 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Reproxy
**🚚 Deliver any files in the GitHub repository**
[](https://github.com/5ouma/reproxy/releases)
[](https://jsr.io/@5ouma/reproxy)
[](https://jsr.io/@5ouma/reproxy)
[](https://github.com/5ouma/reproxy/commit/HEAD)
[](https://github.com/5ouma/reproxy/commits/main)
[](https://github.com/5ouma/reproxy/actions/workflows/ci.yml)
[](https://github.com/5ouma/reproxy/actions/workflows/release.yml)
[](https://results.pre-commit.ci/latest/github/5ouma/reproxy/main)
[](https://codecov.io/github/5ouma/reproxy)
## 💡 Concepts
You can host your specific file on the GitHub repository. The usage I assume is
for one-line scripts. (i.e. dotfiles or some install scripts, like
`curl https://example.com | sh`)
If you access from browsers, you'll redirected to the GitHub page, not a raw
file.
For the development or testing, you can access to the different branches or
tags. To do this, simply add the ref name to the sub-directory. (i.e.
`curl https://example.com/ref | sh`)
## 📊 Usage
### 💻 On Local
1. Copy the [`.env.tmpl`](./.env.tmpl) to `.env` and edit as you prefer
> [🌍 Environment Variables](#-environment-variables)
2. Follow the steps depending on the runtime
- [🦕 Deno](https://deno.com)
1. Run this command
```sh
deno serve -A --env-file='.env' jsr:@5ouma/reproxy
```
- [🍞 Bun](https://bun.sh)
1. Add this code to the `index.ts`
```ts
export { default } from "@5ouma/reproxy";
```
2. Run these commands
```sh
bunx jsr add @5ouma/reproxy
bun run index.ts
```
- [🐢 Node.js](https://nodejs.org)
1. Add this code to the `index.js`
```js
import { serve } from "@hono/node-server";
import app from "@5ouma/reproxy";
serve(app);
```
2. Run these commands
```sh
npm install @hono/node-server
npx jsr add @5ouma/reproxy
node run index.js
```
### 🦕 Use [Deno Deploy](https://deno.com/deploy)
1. [Create a new playground](https://dash.deno.com)
2. Replace the default code with this
```ts
export { default } from "jsr:@5ouma/reproxy";
```
3. Set the environment variables (_Don't forget!!_)
> [🌍 Environment Variables](#-environment-variables)
### ⛅️ Use [Cloudflare Workers](https://workers.cloudflare.com)
1. Set up the `wrangler.toml`
> [🌍 Environment Variables](#-environment-variables)
2. Add this code to the `index.ts`
```ts
export { default } from "@5ouma/reproxy";
```
3. Deploy with these commands
```sh
npx jsr add @5ouma/reproxy
npx wrangler deploy index.ts
```
## 🔨 Development
1. Clone this repository
```sh
git clone https://github.com/5ouma/reproxy.git
```
2. Copy the [`.env.tmpl`](./.env.tmpl) to `.env` and edit as you prefer
> [🌍 Environment Variables](#-environment-variables)
3. Run the [`server.ts`](./src/server.ts) via these task runners
```sh
# For production
deno task start
```
```sh
# For development
deno task dev
```
## 🌍 Environment Variables
| Name | Required |
| :----------------: | :------: |
| `REPOSITORY_OWNER` | yes |
| `REPOSITORY_NAME` | yes |
| `REPOSITORY_PATH` | yes |
| [`GITHUB_TOKEN`] | no |
> [!NOTE]
> You need to add [`GITHUB_TOKEN`] if you want to:
>
> - Access the file in the private repository
> - Avoid the API usage limit
[`GITHUB_TOKEN`]: https://github.com/settings/tokens/new?scopes=repo
## 🆘 Help
- [**⚠️ Issues**]: Feature Requests or Bug Reports
- [**💬 Discussions**]: General Chats or Questions
- [**🛡️ Security Advisories**]: Security Issues that should not be public
[**⚠️ Issues**]: https://github.com/5ouma/reproxy/issues/new/choose
[**💬 Discussions**]: https://github.com/5ouma/reproxy/discussions/new/choose
[**🛡️ Security Advisories**]: https://github.com/5ouma/reproxy/security/advisories/new
## 🎽 Contributing
I happily welcome your contributions! Before you contribute, I would recommend
reading [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for a better development
experience.