Skip to content

5ouma/reproxy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

48 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Reproxy

🚚 Deliver any files in the GitHub repository

GitHub Release GitHub code size in bytes GitHub repo size GitHub last commit GitHub commit activity
Test pre-commit.ci status codecov



πŸ’‘ 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)



πŸ”§ Setup

You can host your file on Deno Deploy.

πŸ’ͺ Manual Deployment

  1. Clone this repository

    git clone https://github.com/5ouma/reproxy.git
  2. Copy the .env.tmpl to .env and edit as you prefer

    🌍 Environment Variables

  3. Install Deno and deployctl.

  4. Deploy to Deno Deploy

    deployctl deploy --prod --env-file='.env'

βš™οΈ Automatic Deployment

  1. Fork this repository

  2. Create a new project with your forked repository

  3. Set the environment variables (Don't forget!!)

    🌍 Environment Variables



πŸ”¨ Development

  1. Clone this repository

    git clone https://github.com/5ouma/reproxy.git
  2. Copy the .env.template to .env and edit as you prefer

    🌍 Environment Variables

  3. Install Deno

  4. Run the server.ts via these task runners

    # For production
    deno task start
    # For development
    deno task dev



🌍 Environment Variables

Name Required
REPOSITORY_OWNER true
REPOSITORY_NAME true
REPOSITORY_PATH true
GITHUB_TOKEN false

Note

You need to add GITHUB_TOKEN if you want to:

  • Access the file in the private repository
  • Avoid the API usage limit



πŸ†˜ Help



🎽 Contributing

I happily welcome your contributions! Before you contribute, I would recommend reading CONTRIBUTING.md for a better development experience.