Gallery of Visuals (Icons, Illustration, ...)

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 and published on the web where they can be searched.

The result can be seen at 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
• Delete the content of the stories folder

then you can develop your gallery:

• Add your images in the gallery folder.
• [Optional] Add a markdown file with the same name than your image for documentation
• Generate the StoryBook stories in the stories folder

yarn generate

• Start storybook to verify

yarn start

• Build. The build:
  • takes the Gallery Url given in the .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 file

yarn build

• Transfer the storybook-static directory on your web server. Example: https://gerardnico.com/doc/gallery/

Rules

• You can add README.md files in the 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 with a file will create a story

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.

TODO

Add Emoji

They can be used in Markdown

• 👉
• ✅
• 💪
• 🎉
• 🙊
• :robot_face:

Doc

• Design Rules
• Command History of this repo