Skip to content

Latest commit

 

History

History
97 lines (61 loc) · 2.73 KB

README.md

File metadata and controls

97 lines (61 loc) · 2.73 KB
Raw

Collaborator Finder Tool

A tool to help developers find potential collaborators for their GitHub projects. This application utilizes the GitHub API to search for users with specific skills, interests, or contributions relevant to your project.

The backend code can be found here https://github.com/nia-cloud-official/collab-backend.git

Features

  • Search by Username: Find users by their GitHub username.
  • Search by Skill: Discover users based on their repositories, skills, or interests. (coming Soon)
  • Search by Contributions: Identify users who have contributed to specific repositories.(coming Soon)
  • Filter by Location: Narrow down search results based on geographical location.(coming Soon)
  • User Profiles: View detailed profiles including repositories, contributions, and activity.

Prerequisites

  • Node.js and npm installed on your machine.
  • A GitHub personal access token for accessing the GitHub API.

Installation

  1. Clone the repository:

    git clone https://github.com/nia-cloud-official/collaborator-finder-tool.git

  2. Navigate to the project directory:

    cd collaborator-finder-tool

  3. Install dependencies:

    npm install

  4. Configure GitHub API token:

    Create a .env file in the root directory and add your GitHub personal access token:

    GITHUB_TOKEN=your_github_personal_access_token

Usage

  1. Start the application:

    npm start

  2. Open your browser and navigate to:

    http://localhost:3000

  3. Use the interface to search for collaborators:

    • Enter search criteria such as username, skill, or repository.
    • View results and explore user profiles.

API Documentation

The tool uses the following GitHub API endpoints:

  • Search Users by Username: GET /users/{username}
  • Search Users by Skills/Repositories: GET /search/users?q={query}
  • Search Users by Contributions: GET /repos/{owner}/{repo}/contributors
  • User Profile: GET /users/{username}

For more details on GitHub's API, visit GitHub API Documentation.

Contributing

We welcome contributions to enhance the functionality of this tool. To contribute:

  1. Fork the repository.
  2. Create a new branch for your changes.
  3. Commit your changes and push the branch.
  4. Open a pull request describing your changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For questions or feedback, please contact miltonhyndrex@gmail.com.

Enjoy finding your next collaborator!