myAwesomeTool

This CLI tool can check if the system has a minimum required version of a dependency installed on it. Moreover, it provides with an option to to update the dependencies to a given version and make a pull request.

About The Project

Above is a video demo of all the commands that can be executed after installation of the project. The complete video demo is available here. The commands are :

1. To see all the options available to use in the command.

myawesometool --help

2. To check if the dependency in the projects of repositories listed in the csv file are upto-date or not.

myawesometool --check <absolute path of the csv file> --for <dependency name> --withVersion <version number>

3. To update the dependency in the projects of repositories listed in the csv file that are not upto-date.

myawesometool --update --check <absolute path of the csv file> --for <dependency name> --withVersion <version number>

(back to top)

Built With

• Node.js

(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

Install the latest version npm

• npm

  npm install npm@latest -g

Installation

1. Clone the repo.

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

2. Go to the project directory.

   cd myawesometool

3. Install NPM packages.

   npm install

4. Update the .env file by assigning PERSONAL_ACCESS_TOKEN a personal-access-token from your github account.
5. Install the project on you local machine.

   sudo npm i -g

6. Fill your local machine's password.
7. Now you are good to go, we can run any command from the given 3 commands given Here.

(back to top)

Errors while tesing on windows

This error can occur, if you are testing this tool on a windows based machine :

1. To solve this issue run the following command on your shell :

  Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

2. The following prompt will appear, simply select `yes to all` option :

3. The issue should now be resolved and you should be able to run the commands on your shell.

For more information, please refer to the Article

(back to top)

Roadmap (Features)

• Command to check if the dependency in the projects of repositories listed in the csv file are upto-date or not
• Command to update the dependency in the projects of repositories listed in the csv file that are not upto-date
  • To identify which modules are required to be updated
  • To send a pull request

(back to top)

Video Demo

demoVideo.mp4

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Manav Deep Singh Lamba - @twitter_handle

Email - [email protected]

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

(back to top)