yashkumarverma / github-spy Goto Github PK

a friendly bot to monitor activity and interactions on github repository

Shell 0.13% TypeScript 96.21% Dockerfile 3.66%

swoc2021 bot

github-spy's Introduction

Github Spy [a WIP project]

About 💭

Do you lead an organization ? or are you a maintainer of some open source project ? Even if you are either of the above, there can be instances when you might be required to generate quick reports of any github organization. This can cover anything as simple as getting name of all repositories or things a bit tricky like ensuring projects contain particular structure.

I was facing a similar issue, and therefore I've written this bot down. In order to operate, it requires a personal access token as an environment variable. Just rename the .env.example file to .env and place it there. Then you're good to go.

Running 💻

The project is written in typescript, so you need a few packages installed to get it working.

# install all dependencies
npm install

# then build the project
npm run build

# after building, run it
npm run start

Once you do this, you'd be prompted your name and email, just to be double sure that you're accessing the details of the right account.

Features ✨

As mentioned, the project is a W.I.P. which means that new features are being readily added to it. If you feel that there needs to be a particular filter / criterion to generate reports, feel free to open an issue regarding it. I'm more than willing to write features for it.

Contribution 👨‍💻

Just in case you're a hobbyist or have developed an interest in this project, we're open to contributions. The contributions can be in the following domains

Testing : the application has absolutely no testing mechanism right now, which would be required as we move forward.
Documentation: As this project has surfaced as an outcome of a personal need, it lacks the documentation that it deserves. I've tried to make code as elaborative as possible, but nothing beats an actual documentation. Feel free to send PRs for adding docs. PR's fixing typos would be closed straight away.
Code: The only reason you see the last few commits done to create a new directory named features is to make it easy to write new filters / features. Feel free in both, suggesting features as well as writing features.

Open-source programs we are a part of 👾

`SWoC(Script Winter of Code)`

Script Winter of Code is an open-source program envisioned by the Script Foundation. It aims to bring students into the world of open source development and see the power of unified problem-solving in real time. The projects that we will host have been carefully hand-picked to invigorate creative thinking and encourage collaboration among all participants.

github-spy's People

Contributors

Stargazers

Watchers

Forkers

hackcode-packages ayush7614 shikharcodes sloth-panda danbrown47

github-spy's Issues

Adding Docker Support

Is your feature request related to a problem? Please describe.

Adding Docker support for an app is a great enhancement than being related to a problem, It can boost up productivity of other developers, Devops Engineers and those who need to run the app in a moment.

Adding Docker support will make it a scale able application

Describe the solution you'd like
The solution is to create a docker file for the project, enabling one to ease up the process of setting up of the environment needed.

A clear and concise description of what you want to happen.
This will enable Github-spy to have more traction among developers as a single command setup would fuel up the environment to experiment and contribute to GitHub spy

Describe alternatives you've considered
There is no alternative decision I have considered apart form dockerizing the application

A clear and concise description of any alternative solutions or features you've considered.

Additional context

I can contribute to this issue, If allowed

Add any other context or screenshots about the feature request here.

Enhancing the Readme.md

@YashKumarVerma, I think we can make Readme.md more interesting by adding some more information.
Please assign me this issue as a Part of Script Winter of Code[SWoC]. I would love to resolve it.

Welcome bot integration

Hello there,
I can add a welcome bot config file having a proper message that will show up when any user will open up an issue or pull-request for the first time as a part of DWOC. Please assign me this issue.
For reference, kindly check out: https://github.com/apps/welcome

And let me know if this needs to be implemented or not

Merge all reports into one.

Currently, the report generated is in form of separate files, write a function that checks if the file for a particular repository exists, and if it does, append data into that file as a new key in the object.

creation of issue and pr template

Let me know if this needs to be done

Adding contributors list to the README.md file.

Is your documentation issue related to a problem? Please describe.

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
There is no list of contributors in the README.md file.

Describe the solution you'd like

A clear and concise description of what you want to happen.
I will add a list of all the contibutors with their profile pics in the README.md file.

Readme beautification

Let me know if this needs to be beautified

Add more details about any report

Currently, the report for star-gazers lists the user-names of the people that have starred the repo, but the file does not contain any other detail about them. Include the total number property in the object that's stored, and convert the array into array.

//currently the format for file: `<repoName>.starGazers.report.json`
["user1","user2"]

change it to

// fileName: `<repoName>.report.json`
{
	"starGazer": {
        "count":2,
        "users":["user1","user2"]
    }
}

creation of contributing file

let me know if this needs to be done

Adding a Code of Conduct file

Hey @YashKumarVerma , while looking at this project I noticed that the Code of Conduct file is missing.
I would like to add this if you want. Please assign me this under SWoC2021 label.