Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ethanbaker/epick

A simple emoji picker in the terminal.
https://github.com/ethanbaker/epick

emoji golang picker terminal terminal-app terminal-application

Last synced: 11 days ago
JSON representation

A simple emoji picker in the terminal.

Host: GitHub
URL: https://github.com/ethanbaker/epick
Owner: ethanbaker
License: apache-2.0
Created: 2021-01-22T22:08:50.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2023-07-17T20:25:42.000Z (over 1 year ago)
Last Synced: 2024-11-15T16:08:41.198Z (2 months ago)
Topics: emoji, golang, picker, terminal, terminal-app, terminal-application
Language: Go
Homepage:
Size: 364 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        



![1.0.0](https://img.shields.io/badge/status-1.0.0-red)

[![GoDoc](https://godoc.org/github.com/ethanbaker/epick?status.svg)](https://godoc.org/github.com/ethanbaker/epick)

[![Go Report Card](https://goreportcard.com/badge/github.com/ethanbaker/epick)](https://goreportcard.com/report/github.com/ethanbaker/epick)

[![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![License][license-shield]][license-url]

[![LinkedIn][linkedin-shield]][linkedin-url]








  

  
Epick


  


    A simple emoji picker for the terminal

  



  Table of Contents

  


    

      About

      

        Built With

      

    

    

      Getting Started

      

        Prerequisites

        Installation

      

    

    Usage

    Roadmap

    Contributing

    License

    Contact

  


## About

![Project demonstration image][product-screenshot]

Epick was designed to reduce the hassle of having to search up the copy and paste for different emojis whenever you want an emoji in a text document. For instance, adding emojis to blog posts in the terminal can be so much easier when using Epick, as you no longer need to copy and paste a character after searching for the perfect emoji for 5 minutes. All you need to do is run the `epick` command, find the preferred emoji, and continue coding!

(back to top)


### Built With

* [Golang](https://go.dev/learn/)

* [Cview](https://code.rocketnine.space/tslocum/cview)

(back to top)


## Getting Started

In order to download and start using epick as a terminal command, you must first clone the git repository to your local system.

In order to use epick in a different application, import it by using the import statement:

`import "github.com/ethanbaker/epick"`

### Prerequisites

* Go is installed

* Your terminal is able to render emojis

### Installation

1. Clone the repository (`git clone [email protected]:ethanbaker/epick.git`)

1. Navigate into the cloned directory

1. Run `go install`

Epick should now be installed!

(back to top)


## Usage

Epick contains multiple pages of different emojis, each of which represents a unique emoji category. These categories are:

* Smileys and Emotion

* People and Body

* Animals and Nature

* Food and Drink

* Travel and Places

* Activities

* Objects

* Symbols

* Flags

You can navigate between different emojis using standard vim bindings (j, j, k, l, g, G).

You can switch between emoji categories by pressing 'C' to go forwards and 'c' to go backwards.

You can quit the app by pressing 'q' or Escape.

You can search for emojis by pressing '?'. This brings up a menu where emojis can be searched for with autocomplete. If you enter a partially incomplete phrase, you can navigate between matching emojis by pressing 'n' to go forwards and 'N' to go backwards.

(back to top)


## Roadmap

- [ ] Documentation

- [ ] Quality-ensurance Refactor

- [ ] Testing

See the [open issues][issues-url] for a full list of proposed features (and known issues).

(back to top)


## Contributing

For issues and suggestions, please include as much useful information as possible.

Review the [documentation][documentation-url] and make sure the issue is actually

present or the suggestion is not included. Please share issues/suggestions on the

[issue tracker][issues-url].

For patches and feature additions, please submit them as [pull requests][pulls-url]. 

Please adhere to the [conventional commits][conventional-commits-url]. standard for

commit messaging. In addition, please try to name your git branch according to your

new patch. [These standards][conventional-branches-url] are a great guide you can follow.

You can follow these steps below to create a pull request:

1. Fork the Project

2. Create your Feature Branch (`git checkout -b branch_name`)

3. Commit your Changes (`git commit -m 'commit_message'`)

4. Push to the Branch (`git push origin branch_name`)

5. Open a Pull Request

(back to top)


## License

This project uses the Apache 2.0 license.

You can find more information in the `LICENSE` file.

(back to top)


## Contact

Ethan Baker - [email protected] - [LinkedIn][linkedin-url]

Project Link: [https://github.com/ethanbaker/epick][project-url]

(back to top)


(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/ethanbaker/epick.svg

[forks-shield]: https://img.shields.io/github/forks/ethanbaker/epick.svg

[stars-shield]: https://img.shields.io/github/stars/ethanbaker/epick.svg

[issues-shield]: https://img.shields.io/github/issues/ethanbaker/epick.svg

[license-shield]: https://img.shields.io/github/license/ethanbaker/epick.svg

[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?logo=linkedin&colorB=555

[contributors-url]: 

[forks-url]: 

[stars-url]: 

[issues-url]: 

[pulls-url]: 

[license-url]: 

[linkedin-url]: 

[project-url]: 

[product-screenshot]: ./docs/demonstration.png

[documentation-url]: 

[conventional-commits-url]: 

[conventional-branches-url]: