{"id":22018492,"url":"https://github.com/flavienbwk/icons-visualizer","last_synced_at":"2026-03-10T11:31:52.773Z","repository":{"id":53156520,"uuid":"229659813","full_name":"flavienbwk/icons-visualizer","owner":"flavienbwk","description":"A quick and simple UI and API to search and display icons or images. Can be used in an offline environment thanks to Docker.","archived":false,"fork":false,"pushed_at":"2025-08-21T18:37:29.000Z","size":1911,"stargazers_count":4,"open_issues_count":6,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-09-07T16:51:44.987Z","etag":null,"topics":["docker","docker-compose","flask-restplus","kubernetes","python3","reactjs","search-engine","visualizer"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flavienbwk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-12-23T02:11:20.000Z","updated_at":"2023-07-16T20:19:35.000Z","dependencies_parsed_at":"2025-06-16T03:32:40.767Z","dependency_job_id":"f3e57ada-c141-4af1-847f-d2965fc2e688","html_url":"https://github.com/flavienbwk/icons-visualizer","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/flavienbwk/icons-visualizer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flavienbwk%2Ficons-visualizer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flavienbwk%2Ficons-visualizer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flavienbwk%2Ficons-visualizer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flavienbwk%2Ficons-visualizer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flavienbwk","download_url":"https://codeload.github.com/flavienbwk/icons-visualizer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flavienbwk%2Ficons-visualizer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30332284,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T05:25:20.737Z","status":"ssl_error","status_checked_at":"2026-03-10T05:25:17.430Z","response_time":106,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","flask-restplus","kubernetes","python3","reactjs","search-engine","visualizer"],"created_at":"2024-11-30T05:12:20.180Z","updated_at":"2026-03-10T11:31:52.753Z","avatar_url":"https://github.com/flavienbwk.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Icons Visualizer\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://travis-ci.org/flavienbwk/icons-visualizer\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://travis-ci.org/flavienbwk/icons-visualizer.svg?branch=master\"/\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://opensource.org/licenses/MIT\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/License-MIT-yellow.svg\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\nA quick and simple UI and API to search and display icons. Can be used in an offline environment thanks to Docker. Database-free.\n\n![Interface example](./interface.png)\n\nWritten in Python (Flask RESTPlus / Swagger) and ReactJS.\n\n## Get started\n\nImport the icons you want in the `icons/` directory.\n\n:information_source: **The name of your files** are very important : the search engine is based on filenames to find search keywords.\n\n### Build for dev\n\n```bash\ndocker-compose up -d\n```\n\nYou can access the UI at `localhost:8080`\n\n### Build for prod\n\n```bash\ndocker-compose -f prod.docker-compose.yml up --build -d\n```\n\nYou can access the UI at `localhost:8080`\n\n### Deploy to K8S\n\nI pretend you have here your K8S instance configured to be accessed by your `kubectl` CLI.\n\nI've used [Scaleway Kapsule](https://www.scaleway.com/en/kubernetes-kapsule) to perform my tests. This is an easy way to have a Kubernetes cluster quickly ready.\n\n1. Building production images (optional)\n\n    Images are tagged `flavienb/icons-visualizer-{api,web,nginx}:latest` by default. Edit it in `prod.docker-compose.yml` before building.\n\n    :information_source: You might be interested in pushing your images in a private registry (e.g: [Scaleway's Container Registry service](https://www.scaleway.com/en/container-registry/)).\n\n    ```bash\n    docker-compose -f prod.docker-compose.yml build\n    ```\n\n    Finally, `docker push` the 3 images and edit K8S' configurations :\n\n    - [k8s/web.yaml, line 26](k8s/web.yaml#L26)\n    - [k8s/api.yaml, line 21](k8s/api.yaml#L21)\n    - [k8s/nginx.yaml, line 21](k8s/nginx.yaml#L21)\n\n2. Add a new `icons-visualizer` namespace\n\n    ```bash\n    kubectl create namespace icons-visualizer\n    ```\n\n3. Considerations on persistant volume for icons\n\n    You have 4 options to see your icons on Kubernetes :\n\n    - Create a `PersistentVolume` with `spec.local` pointing to a path on a node and import your icons inside (requires an SSH access to this node)\n    - Use a remote NFS server\n    - Copy all of your icons in your Docker image\n    - Use a S3 server such as MinIO and import your pictures via a web interface\n\n    For this example, I'll go with MinIO so you have a light image to deploy.\n\n4. Configure your Ingress app endpoint\n\n    - **Define** the app and MinIO endpoints in [k8s/ingress.yaml, line 10 and 20](./k8s/ingress.yaml#L10)\n    - **Check** the env variables in [k8s/env-configmap.yaml](./k8s/env-configmap.yaml)\n    - **Check** the PersistentVolumeClaim if you're not using Scaleway, in [k8s/minio-pvc.yaml](./k8s/minio-pvc.yaml)\n\n    Deploy with :\n\n    ```bash\n    kubectl apply -f ./k8s --namespace icons-visualizer\n    ```\n\n5. Add icons\n\n    Connect to the MinIO interface and add your icons in the `icons` bucket.\n\n    Start a new search in the Icons Visualizer UI and enjoy !\n\n    \u003e :information_source: The API will look up for new icons in S3 and file-system [every minute](./api/app/utils/Icons.py#L15).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflavienbwk%2Ficons-visualizer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflavienbwk%2Ficons-visualizer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflavienbwk%2Ficons-visualizer/lists"}