Skip to content

This project provides a Node.js application to easily download all your starred repositories from GitHub.

License

Notifications You must be signed in to change notification settings

tuanductran/download-repos

Repository files navigation

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

Table of Contents

Installation

To install and use this application, follow these steps:

  1. Clone the repository:

    git clone https://github.com/tuanductran/download-repos.git
  2. Navigate to the project directory:

    cd download-repos
  3. Install the dependencies:

    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:

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:

node index.mjs

Alternatively, if you have built the application using pkg, you can run the built executable:

Linux

./build/download-repos-linux

macOS

./build/download-repos-macos

Windows

./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. The output files are placed in the build directory.
  • clear: Clears the build directory.

You can run these scripts using pnpm:

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 file for more details.

About

This project provides a Node.js application to easily download all your starred repositories from GitHub.

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published