Github-Crawler

Tool using which you can feed multiple github directories to scan for version of dependencies and update them if needed.
Explore the docs »

View Demo

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact

About The Project

Tool using which you can feed multiple github directories to scan for version of dependencies and update them if needed.

(back to top)

Built With

• Node.js
• GitHub API
• Axios

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Get github token at https://github.com/settings/tokens/new?scopes=repo
2. Clone the repo

   git clone https://github.com/dyte-submissions/dyte-vit-2022-Abhay2712

3. Install NPM packages

   cd ./cd Github_Crawler
   npm install

4. Enter your token in .env file

   TOKEN = 'your_token';

(back to top)

Usage

1. cd to the Github-Crawler and do npm install there to install the dependencies
   

2. Keep the csv file in the data folder

3. Setup the github token as environment variable to use github functions

4. To run type the command in following format-- node index.js -i file_name dependency@version -update (-update is optional)
   Eg. node index.js -i github_repos.csv axios@^0.23.0 -update

5. That's it now it will scan the content of csv for dependencies version and will update if needed.

Note- Each time you use the app make sure you update the branch mentioned in head in line 32 of post.js file as it needs a new branch to send a pull request and if you use the same branch again it will give the error that refrence already exist cannot create new one.

(back to top)

Roadmap

• Reading the CSV file
• Getting the dependencies version from github
• Updating the dependency and creating the pull request

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Your Name - @email - abhaysharma754@gmail.com

Project Link: https://github.com/dyte-submissions/dyte-vit-2022-Abhay2712

(back to top)