Code Monkey home page Code Monkey logo

pr-info's Introduction

Pull Request Info

Pull Request Info is a simple Node.js application that leverages the GitHub API to fetch details about open pull requests for a specific GitHub repository.

Features

  • Get details about open pull requests, including the author, number, title, and commit count.
  • Uses ETag and If-None-Match headers for caching to avoid unnecessary GitHub API requests.

Requirements

To run this project, you'll need the following environment variables:

  • GITHUB_TOKEN: A personal access token from GitHub. To generate a new token, follow the instructions in the GitHub documentation.

Note: This application requires the GitHub token to be set as the GITHUB_TOKEN environment variable. If not provided, the application will not run.

How to Run

Development

Install dependencies:

npm install

Start the application:

npm run dev

Production

Build the application:

npm run build

Start the application:

npm start

Running Tests

You can run unit and integration tests with:

npm test

API Usage

Fetch open pull request details for a specific repo:

GET /api/v1/repos/:owner/:repo/pulls

Example: GET /api/repos/github/github/pulls will get the open pull requests for the 'github' repository under the 'github' user/organization.

Each pull request in the response includes the author, title, number, and commit count.

Contributing

We welcome contributions! Please create an issue or open a pull request if you would like to help improve this project.

pr-info's People

Contributors

derickmr avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.