Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kpollich/quick-feather-icons
Quickly copy links to Feather icons for use in Notion and anywhere else
https://github.com/kpollich/quick-feather-icons
Last synced: 1 day ago
JSON representation
Quickly copy links to Feather icons for use in Notion and anywhere else
- Host: GitHub
- URL: https://github.com/kpollich/quick-feather-icons
- Owner: kpollich
- Created: 2020-05-19T20:15:40.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T06:24:47.000Z (almost 2 years ago)
- Last Synced: 2023-02-28T22:51:13.172Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://quick-feather-icons.now.sh
- Size: 1020 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Quick Feather Icons
Quickly copy links to Feather icons for use in Notion and anywhere else
https://quick-feather-icons.now.sh/
## Problem
[Notion](https://www.notion.so/) allows users to provide their own icons and customize the look and feel of their notes. To do this, a user can upload an asset themself or provide a link. The official [website](https://feathericons.com/) for Feather icons is great, and it allows you to easily customize and download SVG's of all their great icons. It does not, however, provide a way to copy a unique URL for each icon. It's cumbersome to download all icons and re-upload them to Notion every time I want to use an icon, so I wanted a an easy way to copy a static link to each icon instead.
## Tech Stack
This is a [Next.js](https://nextjs.org/) website built with [React](https://reactjs.org/) and [Tailwind CSS](https://tailwindcss.com/).
## Installation
To run the project locally, clone the repo, then install dependencies via [Yarn](https://classic.yarnpkg.com/lang/en/) - ensure you're using the "classic" version of Yarn.
```sh
$ git clone [email protected]:kpollich/quick-feather-icons.git
$ cd quick-feather-icons
# Install dependencies
$ yarn
```
Once the installation is complete, you can run `yarn dev` to start a local development server on `http://localhost:3000`
```sh
$ yarn start
```
## API Usage
If you'd prefer not to use the frontend interface, all icons links are exposed at a predictable URL structure via an API endpoint using Next's [API routes](https://nextjs.org/docs/api-routes/introduction).
```sh
curl 'https://quick-feather-icons.now.sh/api/icon?name=activity&color=green'
```
These API requests accept a valid `name` of a given Feather icon and any valid `CSS` color string. The response will contain the raw SVG string with a `Content-Type` header value of `image/svg+xml`.