https://github.com/gerardnico/nicon
My library of visuals (published in a storybook)
https://github.com/gerardnico/nicon
icon storybook visuals
Last synced: about 1 month ago
JSON representation
My library of visuals (published in a storybook)
- Host: GitHub
- URL: https://github.com/gerardnico/nicon
- Owner: gerardnico
- License: cc-by-sa-4.0
- Created: 2017-11-13T09:57:32.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T03:46:45.000Z (over 3 years ago)
- Last Synced: 2025-03-16T09:42:54.058Z (over 1 year ago)
- Topics: icon, storybook, visuals
- Language: JavaScript
- Homepage: https://gerardnico.com/doc/gallery/
- Size: 12.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Gallery of Visuals (Icons, Illustration, ...)
```bash
n(ico) + icon = nicon
```
## Introduction
This repository contains visuals:
* simple (icons, ...)
* composite (composed of simple visual) such as illustration
* and photos
That are organized in a [StoryBook](https://storybook.js.org/) and published on the [web](https://gerardnico.com/doc/gallery/)
where they can be searched.
The result can be seen at [https://gerardnico.com/doc/gallery/](https://gerardnico.com/doc/gallery/)
## Usage
To develop your own gallery, you need to (only once):
* Copy this repo
* Delete the content of the [gallery folder](./gallery/)
* Delete the content of the [stories folder](./stories/)
then you can develop your gallery:
* Add your images in the [gallery folder](./gallery/).
* [Optional] Add a markdown file with the same name than your image for documentation
* Generate the StoryBook stories in the [stories folder](./stories/)
```bash
yarn generate
```
* Start storybook to verify
```bash
yarn start
```
* Build. The build:
* takes the Gallery Url given in the [.env.production](.env.production) file
* generate the story with it
* generate the static storybook
* re-generate the stories with no Gallery Url as set in the [.env](.env) file
```bash
yarn build
```
* Transfer the [storybook-static directory](./storybook-static) on your web server. Example: [https://gerardnico.com/doc/gallery/](https://gerardnico.com/doc/gallery/)
## Rules
* You can add `README.md` files in the [gallery](./gallery/)
* You can add a markdown documentation file next to the image with the same name. ie if the image is `red.png`, the markdown should be named `red.md`.
* Every directory in the [gallery](./gallery/) with a file will create a [story](./stories/)
## Licence
The metadata of each original svg (ie made by me) contains:
* Description
* Title
* Rights: https://creativecommons.org/licenses/by-nc-sa/4.0/
* Publisher: https://gerardnico.com/nicon
* License: CC Attribution-NonCommercial-ShareAlike
The other:
* have a documentation associated with a markdown file with the licence described
* or are royalty free
See also [the threshold of originality](https://commons.wikimedia.org/wiki/Commons:Threshold_of_originality).
## TODO
Add Emoji
They can be used in Markdown
* :point_right:
* :white_check_mark:
* :muscle:
* :tada:
* :speak_no_evil:
* :robot_face:
## Doc
* [Design Rules](./doc/design_rule.md)
* [Command History of this repo](./doc/command_history.md)