Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tuanductran/download-repos
This project provides a Node.js application to easily download all your starred repositories from GitHub.
https://github.com/tuanductran/download-repos
Last synced: about 2 months ago
JSON representation
This project provides a Node.js application to easily download all your starred repositories from GitHub.
- Host: GitHub
- URL: https://github.com/tuanductran/download-repos
- Owner: tuanductran
- License: mit
- Created: 2024-05-27T19:21:51.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-11-14T04:19:20.000Z (2 months ago)
- Last Synced: 2024-11-14T05:20:30.764Z (2 months ago)
- Language: JavaScript
- Size: 55.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Download Your Starred GitHub Repositories
This project provides a Node.js application to easily download all your starred repositories from GitHub.
**[100+ Github Starred Repositories](https://drive.google.com/drive/folders/189uUYB32jQZXWE4XimU55i7vPB-WcD7v)**
## Table of Contents
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Linux](#linux)
- [macOS](#macos)
- [Windows](#windows)
- [Scripts](#scripts)
- [Author](#author)
- [License](#license)
## Installation
To install and use this application, follow these steps:
1. Clone the repository:
```sh
git clone https://github.com/tuanductran/download-repos.git
```
2. Navigate to the project directory:
```sh
cd download-repos
```
3. Install the dependencies:
```sh
pnpm install
```
Before running the application, you need to configure it by setting up the environment variables. Create a `.env` file in the project directory and add the following variables:
- `GITHUB_TOKEN`: Your GitHub personal access token.
- `GITHUB_USERNAME`: Your GitHub username.
You can use the provided `.env.example` file as a template:
```env
GITHUB_TOKEN=your_github_token
GITHUB_USERNAME=your_github_username
```
Copy the contents of .env.example to .env and replace the placeholders with your actual values.
## Usage
This is a CLI application. You can run the application using the following command:
```sh
node index.mjs
```
Alternatively, if you have built the application using pkg, you can run the built executable:
### Linux
```sh
./build/download-repos-linux
```
### macOS
```sh
./build/download-repos-macos
```
### Windows
```sh
./build/download-repos-windows
```
**Note: The actual executable name may vary based on your target platform (Linux, macOS, Windows).**
## Scripts
The following scripts are available in this project:
- build: Builds the application using [pkg](https://github.com/vercel/pkg). The output files are placed in the build directory.
- clear: Clears the build directory.
You can run these scripts using pnpm:
```sh
pnpm build
pnpm clear
```
## Author
This project is authored by Tuan Duc Tran.
## License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.