|
| 1 | +# DownGD <img src="logo.svg" width="50" height="50" align="left"> |
| 2 | + |
| 3 | +> Download directory from a GitHub repo |
| 4 | +
|
| 5 | +GitHub doesn’t let you download a single folder from a repo, which might be necessary when you just need a few files from a large repository. |
| 6 | + |
| 7 | +This tool will handle the download of all the files in a directory, in a single click, after you entered your token. |
| 8 | + |
| 9 | +> You can create a [new token here](https://github.com/settings/personal-access-tokens/new), [example](https://imgbb.com/VWBGvhHm). |
| 10 | +
|
| 11 | + |
| 12 | +The download starts automatically when you visit pass the link to the GitHub directory as `url` parameter, like: |
| 13 | + |
| 14 | +[**downgd.github.io/downgd.github.io/**`?url=https://github.com/mrdoob/three.js/tree/dev/build`](https://downgd.github.io/downgd.github.io/?url=https://github.com/mrdoob/three.js/tree/dev/build) |
| 15 | + |
| 16 | +You can also specify download filename by adding `filename` parameter, like: |
| 17 | + |
| 18 | +[**downgd.github.io/downgd.github.io/**`?url=https://github.com/mrdoob/three.js/tree/dev/build&filename=three-js-build`](https://downgd.github.io/downgd.github.io/?url=https://github.com/mrdoob/three.js/tree/dev/build&filename=three-js-build) to save the file as **three-js-build.zip**. |
| 19 | + |
| 20 | +This is an alternative to the existing [GitZip](https://kinolien.github.io/gitzip/) and [DownGit](https://minhaskamal.github.io/DownGit/) but without the cruft. |
| 21 | + |
| 22 | +## Development Guide |
| 23 | + |
| 24 | +To run the project locally or contribute, follow these steps: |
| 25 | + |
| 26 | +### Prerequisites |
| 27 | + |
| 28 | +Make sure you have the following installed: |
| 29 | + |
| 30 | +- [Node.js](https://nodejs.org/) |
| 31 | +- [Git](https://git-scm.com/) |
| 32 | + |
| 33 | +### Setup |
| 34 | + |
| 35 | +1. **Clone the repository:** |
| 36 | + |
| 37 | + ```bash |
| 38 | + git clone https://github.com/downgd/downgd.github.io |
| 39 | + cd downgd.github.io |
| 40 | + ``` |
| 41 | + |
| 42 | +2. **Install dependencies:** |
| 43 | + |
| 44 | + ```bash |
| 45 | + npm install |
| 46 | + ``` |
| 47 | + |
| 48 | +3. **Start development server:** |
| 49 | + |
| 50 | + ```bash |
| 51 | + npm start |
| 52 | + |
| 53 | + # or |
| 54 | + |
| 55 | + npm run watch:build |
| 56 | + ``` |
| 57 | + |
| 58 | + This runs: |
| 59 | + |
| 60 | + * TypeScript in watch mode |
| 61 | + * Parcel dev server at [http://localhost:1234](http://localhost:1234) |
| 62 | + * Vitest in watch mode for unit testing |
| 63 | + |
| 64 | +## Related |
| 65 | + |
| 66 | +- [list-github-dir-content](https://github.com/fregante/list-github-dir-content) - List all the files in a GitHub repo’s directory |
| 67 | +- [Refined GitHub](https://github.com/refined-github/refined-github) - Browser extension that adds a link to this app to GitHub (and much more) |
| 68 | + |
| 69 | +## License |
| 70 | + |
| 71 | +MIT © [M Ramzan Ch](http://twitter.com/rm4814691) |
0 commit comments