https://github.com/alvarowolfx/iconik
CLI tool for generating icons for iOS and Android apps.
https://github.com/alvarowolfx/iconik
android app flutter icon ionic ios react-native
Last synced: about 1 year ago
JSON representation
CLI tool for generating icons for iOS and Android apps.
- Host: GitHub
- URL: https://github.com/alvarowolfx/iconik
- Owner: alvarowolfx
- License: mit
- Created: 2018-12-21T03:32:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-15T22:17:02.000Z (over 3 years ago)
- Last Synced: 2024-04-14T15:19:43.818Z (about 2 years ago)
- Topics: android, app, flutter, icon, ionic, ios, react-native
- Language: JavaScript
- Size: 98.6 KB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# iconik - App Icon Generator
CLI tool for generating icons for iOS and Android apps.
The goal of the project is to generate the icons necessary, detect the project architeture (Native, React Native, Flutter, Cordova, etc) and setup all the icons accordingly.
### Goals
- [x] Generate icons in all needed sizes.
- [x] Publish as NPM package.
- [ ] Detect project architecture.
- [ ] Setup icons files accordingly to the project architecture.
- [ ] Add option to zip all icons.
### Install
```
npm install -g iconik
```
### Usage
```
Generate app icons in all different sizes.
USAGE
$ iconik ICON
ARGUMENTS
ICON input icon
OPTIONS
-h, --help show CLI help
-o, --output=output [default: icons] output folder
-v, --version show CLI version
--android generate android icons
--ios generate ios icons
DESCRIPTION
Generate app icons in all different sizes.
Please provide an icon with at least 512x512px.
```
### Example Output
```
$ iconik icon.png
✔ Check Input
✔ Image Check
✔ Check output
✔ Generate icons
$ ls icons
hdpi.png iPadSpotlight40x40@2x.png iPhoneSettings29x29@2x.png playStore.png
iPad76x76@2x.png iPhone60x60@2x.png iPhoneSettings29x29@3x.png xhdpi.png
iPadNotification20x20@2x.png iPhone60x60@3x.png iPhoneSpotlight40x40@2x.png xxhdpi.png
iPadPro83.5x83.5@2x.png iPhoneNotification20x20@2x.png iPhoneSpotlight40x40@3x.png xxxhdpi.png
iPadSettings29x29@2x.png iPhoneNotification20x20@3x.png mdpi.png
```
### Running locally
```
$ ./bin/run ICON
```
### Credits
* [sharp](https://github.com/lovell/sharp) - Blazing fast image resize module.
* [ocli](https://oclif.io) - Awesome CLI Framework.