Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rollingghost/github-activity
A simple command line interface (CLI) to fetch the recent activity of a GitHub user and display it in the terminal.
https://github.com/rollingghost/github-activity
deno denoland github-activity github-api typescript
Last synced: about 1 month ago
JSON representation
A simple command line interface (CLI) to fetch the recent activity of a GitHub user and display it in the terminal.
- Host: GitHub
- URL: https://github.com/rollingghost/github-activity
- Owner: rollingghost
- Created: 2024-09-04T13:24:26.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-04T16:44:27.000Z (2 months ago)
- Last Synced: 2024-09-29T18:41:04.071Z (about 2 months ago)
- Topics: deno, denoland, github-activity, github-api, typescript
- Language: TypeScript
- Homepage:
- Size: 34.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub Activity Fetcher
## Overview
GitHub Activity Fetcher is a TypeScript application that fetches and displays
recent GitHub activities for a specified user. The application retrieves
information about issues, pull requests, and repositories, and formats the
output in a human-readable format.
## Project URL
Find the project [here](https://roadmap.sh/projects/github-user-activity) on
[roadmap.sh](https://roadmap.sh)
## Features
- Fetches recent issues and pull requests contributions.
- Retrieves commit history for repositories.
- Outputs formatted information to the terminal.
## Prerequisites
- [Deno](https://deno.land/) (Ensure you have Deno installed on your machine)
## Setup
1. Clone the repository:
```sh
git clone https://github.com/your-username/github-activity-fetcher.git
cd github-activity-fetcher
```
2. Set up your GitHub Personal Access Token:
- Create a `.env` file in the root directory.
- Add your GitHub token to the `.env` file:
```sh
GITHUB_TOKEN=your_github_token
```
## Usage
1. Run the application:
```sh
deno run --allow-net --allow-env main.ts
```
Replace `` with the GitHub username you want to fetch
activities for.
## Example
To fetch activities for the user `Harshita-mindfire`, run:
```sh
deno run --allow-net --allow-env main.ts Harshita-mindfire
```
## Project Structure
- [`main.ts`](./main.ts): The main entry point of the application. It fetches
and formats the GitHub activities.
- [`main_tests.ts`](./main_test.ts): Can be used to write tests
## Contributing
Contributions are welcome! Please open an issue or submit a pull request for any
improvements or bug fixes.
## License
This project is licensed under the MIT License. See the LICENSE file for
details.