DEV Community: Rocktim Saikia

Github-dlr: Download individual files and folders from Github recursively.

Rocktim Saikia — Sun, 01 Sep 2024 14:35:37 +0000

Have you ever needed just one file or a specific folder from a GitHub repository but didn’t want to clone the entire project? As a terminal enthusiast, I often found myself in this situation, and it led me to create a tool that solves this problem in the simplest way possible.

What is `github-dlr`?

github-dlr is a terminal tool designed to make your life easier by allowing you to download individual files and folders from a GitHub repository without the hassle of cloning the entire repository. Whether you’re working with large projects or just need a specific part of a repo, github-dlr gets it done with just a few keystrokes.

Check out the project on GitHub:

rocktimsaikia / github-dlr

Download individual files and folders from Github recursively.

Who Can Benefit from `github-dlr`?

This tool is perfect for:

Terminal Power Users: If you’re comfortable with the terminal and have Python installed, github-dlr is a lightweight and efficient solution for grabbing specific files from GitHub.
Linux Enthusiasts: For those who enjoy customizing their Linux setups (often referred to as "ricing"), this tool is particularly useful. Whether you’re after individual wallpapers, config files, or scripts from various repositories, github-dlr makes it quick and easy to download exactly what you need.

Why I Created `github-dlr`

The motivation behind github-dlr came from my own frustrations. Time and again, I found myself wanting just a single file or a specific folder from a public GitHub repository, only to realize there wasn’t a straightforward way to do it through the terminal. While there are websites that offer this functionality, I wanted something that could be accessed directly from the terminal with minimal effort.

As a terminal power user, I prefer tools that are just a few keystrokes away. So, I decided to build github-dlr—a tool that aligns with the way I work and, hopefully, with the way many of you work too.

How `github-dlr` Works

Using github-dlr is incredibly simple. After installing the tool, you can use a single command to download any specific file or folder from a GitHub repository. No more unnecessary cloning, no more navigating through massive project structures—just the files you need, right when you need them.

Feedback and Contributions

I’m really excited to share this tool with the community, and I’m eager to hear your feedback. Whether you have suggestions for new features, improvements, or just want to share how you’re using github-dlr, I’d love to hear from you. You can reach out through GitHub or leave a comment below.

Check out the project and give it a try:

rocktimsaikia / github-dlr

Download individual files and folders from Github recursively.

Thank you for your support, and I hope github-dlr becomes a useful tool in your development toolkit!

I built a simple anime quotes API with Next.js and Koa.✨

Rocktim Saikia — Sun, 28 Feb 2021 12:18:23 +0000

Hi Guys, I just quickly wanted to share with you all my recently re-created side project Animechan. A tiny rest API that serves your favorite anime quotes in no-time. You can use this API in any of your personal projects.

The project is built upon :

Next.js (frontend)
Koa.js (backend)
TailwindCSS
MongoDB.

Thanks :)

✨ module to read git user config from the system and return it as a JSON object.

Rocktim Saikia — Sun, 11 Oct 2020 18:04:33 +0000

rocktimsaikia / read-git-user

Returns the GitHub username and email of the current system's .gitconfig

Read-git-user is a tiny 1.3kB✨ module that can be used to retrieve the git username and email right from the systems global .gitconfig file.

How this works is that the module looks for HOME || USERPROFILE and reads the ini file from there and returns it as a parsed JSON object.

Usage

import readGitUser = require('read-git-user');

(async () => {
        const gitUser = await readGitUser();
        //=> {user: rocktimsaikia, email: rocktimsaikia@gmail.com}

        const gitUser = readGitUser.sync()
        //=> {user: rocktimsaikia, email: rocktimsaikia@gmail.com}
})();

[ PS: I created this tool to use it in a project that I am working on. I thought someone might find it handy so made a quick post. Leave a star at the repo 🌟 if find this helpful. Thanks for reading 👋]

✨ Github-feed-cli : Github feed right at your terminal.

Rocktim Saikia — Sat, 10 Oct 2020 17:36:42 +0000

✨ Github-feed-cli is a cli app that brings your GitHub feed right to your terminal.

rocktimsaikia / github-feed-cli

✨ Github feed right at your terminal

Most of the time while I am coding I have this habit of quickly checking my GitHub feed for no reason.
So I thought it would really cool if I could take a quick look at my GitHub feed right from my working terminal.

Well, that idea alone was enough for me to fork my my extended boilerplate and start coding at 1.20 AM at the morning for the cli app that does exactly the job that I mentioned which is Bringing GitHub feed to my your terminal

Here is how to get strated with this tool:

Installation

$ npm install --global github-feed-cli

Usage

Usage
    $ feed <options>

Options
    --username, -u Github username to fetch the feed [default: Your own git username]
    --page, -p Page number of the results to fetch [default: 1]
    --version, -v Get the current version

Examples
    $ feed
    $ feed --page 2
    $ feed --username rocktimsaikia
    $ feed --username rocktimsaikia -page 2

When you simply run feed without any flags/input it will fetch and show your current GitHub feed.
You can also see any other GitHub users feed too by adding the --username flag following the github username of the person you wanna check.
If you want to go to the next page of the feed, you can simply pass in --page following by the page number. Default is 1.

[ PS: This was a fun little project and I had an awesome time coding it. I thought someone else might find it interesting too so made a quick post on it.
Also leave a star at the repo 🌟 if you like this project. Thanks for reading 🦄 👋]

Need an active Maintainer 👷🏼 for a beginner-friendly open source project.

Rocktim Saikia — Thu, 08 Oct 2020 19:27:29 +0000

rocktimsaikia / Contribute-101

✨ A simple project to get you started with your first open source contribution.

✨ Contribute-101 is a simple beginner-friendly open source project that I have been maintaining for quite a long time now. But due to my latest internship and personal projects, I don't have much time nowadays to actively maintain the project anymore.

So I wanted to write a post in a hope to find someone having a good knowledge of both open source and git in particular to further maintain this project. It is not that I am completely going to step away from the project but I just can't give the time anymore like I used to a few months ago.

So if anyone experienced in open source wants to help and be an active maintainer then please leave a comment with your Github profile below :) 🦄 👋.

✨ Flatify-obj: Flatten nested objects into a single-depth object.

Rocktim Saikia — Mon, 05 Oct 2020 14:26:18 +0000

✨ Flatify-obj is a simple module that flattens nested javascript objects into a single-depth object.

rocktimsaikia / flatify-obj

Flatten nested javascript objects into a single-depth object.

This module can come in pretty handy in situations where you are dealing with deeply nested objects.

Installation

npm install flatify-obj

Usage

const flattenObject = require('flatify-obj');

flattenObject({foo: {bar: {unicorn: '🦄'}}})
//=> { 'foo.bar.unicorn': '🦄' }

flattenObject({foo: {unicorn: '🦄'}, bar: 'unicorn'}, {onlyLeaves: true});
//=> {unicorn: '🦄', bar: 'unicorn'}

✨ read-packages : a simple package that returns the dependencies of a package.json file.

Rocktim Saikia — Sun, 04 Oct 2020 14:11:55 +0000

I wrote a simple module that returns the dependencies of a package.json file.

It has some additional options that you can pass in. Check the project readme for more info.

Installation

npm install read-packages

Usage

const readPackages = require('read-packages');

(async()=>{
       console.log(await readPackages());
       //=> {dependencies: {foo: '^1.0.0',..}, devDependencies: {bar: '^2.0.0',...}}

       console.log(await readPackages({dir: './some/other/directory'}));
       //=> {dependencies: {...}, devDependencies: {...}}

       console.log(await readPackages({removePrefix: true}));
       //=> {dependencies: {foo: '1.0.0',..}, devDependencies: {bar: '2.0.0',...}}

       console.log(await readPackages({removePrefix: true, flattenPackages: true}));
       //=> {foo: '1.0.0',bar: '2.0.0',...}
})();

rocktimsaikia / read-packages

Read dependencies of a package.json file.

read-packages

Read dependencies of a package.json file.

Install

npm install read-packages

Usage

const readPackages = require('read-packages');

(async()=>{
        console.log(await readPackages());
        //=> {dependencies: {foo: '^1.0.0',..}, devDependencies: {bar: '^2.0.0',...}}

        console.log(await readPackages({dir: './some/other/directory'}));
        //=> {dependencies: {...}, devDependencies: {...}}

        console.log(await readPackages({removePrefix: true}));
        //=> {dependencies: {foo: '1.0.0',..}, devDependencies: {bar: '2.0.0',...}}

        console.log(await readPackages({removePrefix: true, flattenPackages: true}));
        //=> {foo: '1.0.0',bar: '2.0.0',...}
})();

Usage without `async`

The module has a sync property to use the lib without async. All the other options works just the same.

const readPackages = require('read-packages');
console.log(readPackages.

…

View on GitHub

[PS: Thought someone might find it a handy tool so I made a quick post. Thanks for reading 🦄 👋]

Get the availabe MIME types of a given extension.

Rocktim Saikia — Fri, 02 Oct 2020 19:55:43 +0000

I just recently published a simple node module that returns the availabe starndard MIME types of a given an extension.

Installation

npm install mime-type-check

Usage

const getMimeType = require('mime-type-check');

getMimeType('svg'); //=> ['image/svg+xml']
getMimeType('png'); //=> ['image/png']
getMimeType('3gpp') //=> ['audio/3gpp', 'video/3gpp']

rocktimsaikia / mime-type-check

Check all the available MIME types of an extension

mime-type-check

Check all the available MIME types of a extension.

It uses Mime-db as its core database.
Do not use this module to actually check the MIME type of a local or remote file. For that use File-type

Install

npm install mime-type-check

Usage

const getMimeType = require("mime-type-check");

getMimeType("svg"); //=> ['image/svg+xml']
getMimeType("png"); //=> ['image/png']
getMimeType("3gpp"); //=> ['audio/3gpp', 'video/3gpp']

API

getMimeType(string)

string is the extension to check the mimetypes for.

License

MIT © Rocktim Saikia

View on GitHub

[PS: I created this module to use it in another project that I am currently workin on. Thought someone might find it helpful so made a quick post.]

meta-fetcher: URL meta-data fetcher for Node.js

Rocktim Saikia — Sat, 12 Sep 2020 15:27:03 +0000

Hi, Myself Rocktim Saikia. And today I want to showcase a simple project that I have been working on for couple of days now.

meta-fetcher 🔎

meta-fecther is simple and tiny url meta-data fetcher for Nodejs. Under the hood this module uses node-fetch to fetch the meta tags of given website url and returns the parsed meta-data as a JSON object.

rocktimsaikia / meta-fetcher

Simple metadata scrapper for node.js

meta-fetcher

Simple metadata scrapper.

Installation

yarn add meta-fetcher

Usage

import metaFetcher from 'meta-fetcher';

const result = await metaFetcher('https://hoppscotch.io/');

console.log(result);

Output:

{
  "title": "Hoppscotch - Open source API development ecosystem",
  "description": "Helps you create requests faster, saving precious time on development.",
  "image": "https://hoppscotch.io/og.png",
  "url": "https://hoppscotch.io/",
  "siteName": "Hoppscotch",
  "type": "website"
}

API

metaFetcher(input)

Takes one url string as a parameter and returns an object containing the meta-information.

input

type: string
default: 'none'

The url string to be scrapped.

page-scrapper: Node.js scrapper that pulls out all links and images of a given site.

License

2024 MIT © Rocktim Saikia

View on GitHub

Install

npm install meta-fetcher

Basic Usage

const {fetchMetaData} = require('meta-fetcher');

(async () => {
    const result = await fetchMetaData('https://hoppscotch.io/');
        console.log(result);

    /*
        {
        basic_metadata: {
            website: 'https://hoppscotch.io/',
            title: 'Hoppscotch • A free, fast and beautiful API request builder',
            description: 'A free, fast and beautiful API request builder'
        },
        opengraph: {
            'og:image': 'https://hoppscotch.io/banner.jpg',
            'og:type': 'website',
            'og:title': 'Hoppscotch',
            'og:site_name': 'Hoppscotch',
            'og:description': 'A free, fast and beautiful API request builder',
            'og:url': 'https://hoppscotch.io/'
        },
        opengraph_social: {
            'twitter:card': 'summary_large_image',
            'twitter:site': '@liyasthomas',
            'twitter:creator': '@liyasthomas'
        },
        favicons: [
            'https://hoppscotch.io/icon.png',
            'https://hoppscotch.io/icon.png',
            'https://hoppscotch.io/_nuxt/icons/icon_64x64.9834b3.png'
        ]
        }
    */ 
})();

It can also fetch meta-data from shortened-url.
For example:

const {fetchMetaData} = require('meta-fetcher');

(async () => {
    const result = await fetchMetaData('https://bit.ly/2Fj9sNF');
    console.log(result);
})();

There a few advanced options that you can use before fetching. You can check them in the readme.md section.

If you like the project. Do leave a star at repo 🌟

Badge it- A Github Action to automate the process of adding Badges to your Readme.

Rocktim Saikia — Tue, 25 Aug 2020 16:58:53 +0000

Hi, Myself Rocktim and this is my submission for Actionshackathon.

My Workflow

What is Badge-it?

Badge-it is a simple GitHub action that automates the process of adding the Badges to your projects Readme ⚡ We all love to add badges to our GitHub projects to decorate it in a way so that the project does not look dull.

But the process of adding badges every time you create a GitHub project can be quite tedious. From all the copy-pasting to configuring your github_username and repo_name. And that's what I tried to solve with Badge-it. It saves you the time of configuring and adding badges
yourself manually.

Submission Category:

I am submitting this action under the following categories.

Interesting IoT
Wacky Wildcards)

Yaml File or Link to Code

Usage

The action takes 3 inputs.

A Github token
A string of badges separated by commas(,)

A base style for your badges.

      - name: Add Badges
        uses: rocktimsaikia/badge-it@master
        with:
          GITHUB_TOKEN: ${{ secrets.MY_TOKEN }}
          badges: 'gh_license, gh_version, github_stars'
          badge-style: 'flat-square'

Bagde-it Repo

rocktimsaikia / badge-it

Github action to automatically add badges to your readme ⚡

badge-it

Github action to automatically add shield badges to your README.md ⚡

A Github action to add badges in your README.md without any hassle. We love badges but generially it's a tedious job to copy paste badges from shield.io to your README.md .So this Action helps to add badges without you having to do all the copy pasting and configuration.

DEMO REPO

Usage

Badges - To add your preffered badge, check it's correspoding key in the Availabe Badges section below and add the key in the badges input seperated by commas (,).
Badge Style - To specifiy style for your badges .Add your preffered badge style in the badge-style input. Default is flat.

- name: Add Badges
  uses: rocktimsaikia/badge-it@master
  with:
    GITHUB_TOKEN: ${{ secrets.MY_TOKEN }}
    badges: 'gh_license, gh_version, gh_stars'
    badge-style: 'flat-square'

Inputs

GITHUB_TOKEN - A personal Github token.
badges…

View on GitHub

Additional Resources / Info

Currently, there is no open-source project using this action. So in the meantime, I am linking a demo repository for demo purposes.

Thank you for taking the time and checking out badge-it. If you like the project don't forget to add a star ⚡ or if you want to contribute you are more then welcome. 🚀

Update 🚀 ⚡

newly added badges will be updated here

Scaffold your GitHub actions with Yeoman generator 🚀

Rocktim Saikia — Sun, 23 Aug 2020 12:00:53 +0000

I created a Yeoman generator to easily scaffold your javascript-based Github actions.

RocktimSaikia / generator-github-action

Yeoman generator for scaffolding your javascript github action.

generator-github-action

A yeoman generator for scaffolding your javascript Github action

💡 About

This is a yeoman generator for the official github action template for javascript provided by the Github team.

⚡ Installation

skip the first step if you already have yeoman installed globally.

npm install -g yo
npm install -g generator-github-action

Then generate your new project:

yo github-action

License

View on GitHub

Since the #actionshackathon is going on, there are going to be lots of forking and templating boilerplates. So I sat down and decided to create a Generator for this specific task so that you don't have to fork boilerplates every time you want to create a new Github Action.

Here is the Installation process followed by the Usage steps:

Installation

npm install -g yo
npm install -g generator-github-action

If you already have yo installed globally then skip the first step. Install the generator only.

Example usage

yo github-action

That will present a prompt asking a few questions about your project name and description etc. After that, It will generate a minimal set up for you to work on a javascript based Github action.

The generator will also install the bare minimum dependencies too so you don't have to worry about installion. You can just focus on writing your code for the action.

That's all 🦄 🦄 🦄

If you want to contribute to the project you can do that too. You can also leave star ⚡ if you find this tool helpful that helps on keeping me motivated to keep creating these types of tools and modules.

How to host api and frontend sepaparetly while using the same domain ??

Rocktim Saikia — Sun, 16 Aug 2020 13:35:51 +0000

I have express API repository which is currently hosted in Heroku along with its documentation site written in ejs.

But now I'm planning on separating the docs website with gatsby and moving it into another repo and hosting it on Netlify while the API service still remains in Heroku.

Here is the end goal :

//example domain: example.com

"/" 
// example.com/ : serves the docs website.(Netlify)

"/api"
// example.com/api : serves the API services. (Heroku)

Can someone help me with how to implement this in the actual application? I am not very familiar with separating hostings while using the same domain.

DEV Community: Rocktim Saikia

Github-dlr: Download individual files and folders from Github recursively.

What is github-dlr?

rocktimsaikia / github-dlr

Download individual files and folders from Github recursively.

Who Can Benefit from github-dlr?

Why I Created github-dlr

How github-dlr Works

Feedback and Contributions

rocktimsaikia / github-dlr

Download individual files and folders from Github recursively.

I built a simple anime quotes API with Next.js and Koa.✨

✨ module to read git user config from the system and return it as a JSON object.

rocktimsaikia / read-git-user

Returns the GitHub username and email of the current system's .gitconfig

Usage

✨ Github-feed-cli : Github feed right at your terminal.

rocktimsaikia / github-feed-cli

✨ Github feed right at your terminal

Installation

Usage

Need an active Maintainer 👷🏼 for a beginner-friendly open source project.

rocktimsaikia / Contribute-101

✨ A simple project to get you started with your first open source contribution.

✨ Flatify-obj: Flatten nested objects into a single-depth object.

rocktimsaikia / flatify-obj

Flatten nested javascript objects into a single-depth object.

Installation

Usage

✨ read-packages : a simple package that returns the dependencies of a package.json file.

Installation

Usage

rocktimsaikia / read-packages

Read dependencies of a package.json file.

read-packages

Install

Usage

Usage without async

Get the availabe MIME types of a given extension.

Installation

Usage

rocktimsaikia / mime-type-check

Check all the available MIME types of an extension

mime-type-check

Install

Usage

API

getMimeType(string)

License

meta-fetcher: URL meta-data fetcher for Node.js

meta-fetcher 🔎

rocktimsaikia / meta-fetcher

Simple metadata scrapper for node.js

meta-fetcher

Installation

Usage

API

metaFetcher(input)

input

Related

License

Install

Basic Usage

Badge it- A Github Action to automate the process of adding Badges to your Readme.

My Workflow

What is Badge-it?

Submission Category:

Yaml File or Link to Code

rocktimsaikia / badge-it

Github action to automatically add badges to your readme ⚡

badge-it

DEMO REPO

Usage

Inputs

Additional Resources / Info

Update 🚀 ⚡

Scaffold your GitHub actions with Yeoman generator 🚀

RocktimSaikia / generator-github-action

Yeoman generator for scaffolding your javascript github action.

generator-github-action

What is `github-dlr`?

Who Can Benefit from `github-dlr`?

Why I Created `github-dlr`

How `github-dlr` Works

Usage without `async`