Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tubone24/giphy-lgtm

Get an LGTM image from GIPHY and create a link in Markdown format that you can put in your PR. (Google Chrome Extensions)
https://github.com/tubone24/giphy-lgtm

chrome-extensions giphy-api lgtm

Last synced: 1 day ago
JSON representation

Get an LGTM image from GIPHY and create a link in Markdown format that you can put in your PR. (Google Chrome Extensions)

Host: GitHub
URL: https://github.com/tubone24/giphy-lgtm
Owner: tubone24
License: mit
Created: 2021-07-31T07:51:08.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2023-12-15T14:32:17.000Z (about 1 year ago)
Last Synced: 2024-04-13T04:55:37.170Z (9 months ago)
Topics: chrome-extensions, giphy-api, lgtm
Language: TypeScript
Homepage:
Size: 2.2 MB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 14
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # GIPHY LGTM

> Get an LGTM image from [GIPHY](https://giphy.com/) and create a link in Markdown format that you can put in your Pull Request.

![demo](docs/images/demo.png)

## background

[LGTM](https://www.dictionary.com/e/acronyms/lgtm/) images are often used in GitHub PR, and it's always more fun to have them move as GIF animations if possible.

 

 I often use a service called GIPHY to search for suitable LGTM images, but I wanted to make it easy to create Markdown links for LGTM images in a consistent way, so I decided to create a dedicated Google Chrome extension.

### What does LGTM mean?

> LGTM is an acronym meaning looks good to me, frequently used when reviewing documents.

> 

> (Quotes from [dictionary.com](https://www.dictionary.com/e/acronyms/lgtm/))

## Feature

![img](docs/images/popup.png)

- Search for GIFs with any keyword from GIPHY and display them on the extension.

- You can generate image links for markdown from the image list view and save them to the clipboard.

- The number of search results is represented by the extension's badge.

![img](docs/images/option.png)

- You can specify any search keyword from the options.

## Install

### Precondition

#### First of all, **you need to create an API key** in your [GIPHY](https://giphy.com/) account.

Create an App from create an App by visiting [GIPHY Developers](https://developers.giphy.com/).

![get_start_giphy](docs/images/get_start_giphy.png)

The App is created in API mode.

![select_api_mode](docs/images/select_api_mode.png)

Fill in the required information to complete the App.

![fill_in](docs/images/fill_in.png)

Write down the API Key that is set for the App you created. You'll use it later.

![api_key](docs/images/api_key.png)

### Install the extension on your Chrome

Download the latest version of the ZIP file from the extension's release site.

![release](docs/images/release.png)

Extract the zip to any directory on your PC and open Google Chrome.

Open , select **Load unpackaged extensions**, and specify the directory where you extracted the zip file earlier.

![install_extension](docs/images/install_extension.png)

You should now be able to load it successfully.

### Set your API Key

Configure APIKey from the Extension Options screen.

![img](docs/images/extension_option_list.png)

Set the option to the API Key you wrote down earlier.

![img](docs/images/option.png)

## For Developer

Build production

```

npm run build

```

Run local

```

npm run watch

```

Format code style with prettier

```

npm run style

```

Test with jest

```

npm run test

```