{"id":24708077,"url":"https://github.com/pungrumpy/image-logger","last_synced_at":"2025-10-09T09:31:55.202Z","repository":{"id":180840776,"uuid":"665787727","full_name":"PunGrumpy/image-logger","owner":"PunGrumpy","description":"🖼️ This is a simple image logger that logs images to a file and sending them to a discord webhook.","archived":false,"fork":false,"pushed_at":"2024-04-12T11:27:55.000Z","size":106,"stargazers_count":5,"open_issues_count":0,"forks_count":5,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-01T19:30:57.065Z","etag":null,"topics":["image-logger","javascript"],"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/PunGrumpy.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}},"created_at":"2023-07-13T02:25:58.000Z","updated_at":"2023-11-20T02:43:48.000Z","dependencies_parsed_at":"2023-07-13T03:38:36.247Z","dependency_job_id":"ac666620-d047-439b-b29b-6fb66cef6991","html_url":"https://github.com/PunGrumpy/image-logger","commit_stats":null,"previous_names":["pungrumpy/image-logger"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PunGrumpy%2Fimage-logger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PunGrumpy%2Fimage-logger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PunGrumpy%2Fimage-logger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PunGrumpy%2Fimage-logger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PunGrumpy","download_url":"https://codeload.github.com/PunGrumpy/image-logger/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235810532,"owners_count":19048550,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["image-logger","javascript"],"created_at":"2025-01-27T06:27:43.211Z","updated_at":"2025-10-09T09:31:49.829Z","avatar_url":"https://github.com/PunGrumpy.png","language":"JavaScript","readme":"# `🖼️` Image Logger\n\n## `📝` Description\n\nThis is a simple image logger that logs images to a file and sending them to a discord webhook.\n\n## `📚` How to use\n\n### `📦` Requirements\n\n- Node.js v20.0.0 or higher\n- NPM v7.0.0 or higher\n- PNPM v6.0.0 or higher\n\n### `📥` Installation\n\n```bash\npnpm install\n```\n\n### `⚙️` Configuration\n\nCreate a `config.json` you can use the `config.example.json` as a template.\n\n```json\n{\n  \"webhooks\": [\n    {\n      \"name\": \"NAME OF WEBHOOK\",\n      \"url\": \"URL OF WEBHOOK\"\n    }\n  ],\n  \"image\": [\n    {\n      \"name\": \"NAME OF IMAGE\",\n      \"path\": \"URL OF IMAGE or PATH OF IMAGE\" // src/assets/IMAGE_NAME.png\n    },\n    {\n      \"name\": \"NAME OF IMAGE\",\n      \"path\": \"URL OF IMAGE or PATH OF IMAGE\" // src/assets/IMAGE_NAME.png\n    }\n  ]\n}\n```\n\nYou can also use `enviroment variables` to configure the project.\n\n```env\nHEALTHCHECK_USER_AGENT=USER AGENT FOR HEALTHCHECK # Edit on Dockerfile\n```\n\nand then update your environment variables on your machine.\n\n```bash\nexport HEALTHCHECK_USER_AGENT=\"USER AGENT FOR HEALTHCHECK\"\n```\n\n\u003e **Note**: You can add as webhooks url on `config.json` as you want.\n\n### `🖼️` Preparing images\n\n1. Create a folder called `assets` or whatever you want in the [src](./src/) folder.\n2. Add your images to the folder.\n3. Add the images path to the `config.json` file.\n\n### `📝` Post Image\n\nYou can `POST` images to the `/image` endpoint.\n\n## `🚌` Deploying\n\n### `💻` Local\n\n```bash\npnpm start\n```\n\n### `🐳` Docker\n\n```bash\ndocker compose up -d\n```\n\n### `▲` Vercel\n\nYou can using the [Vercel](https://vercel.com/) platform to deploy this project.\n\n\u003e **Note**: Don't forget to add the `config` and `image` to the project before deploying.\n\n## `📝` API\n\n### `🖼️` Post Image\n\n```bash\ncurl -X POST -H \"Content-Type: application/json\" -d '{\"image\": \"IMAGE URL\", \"imageName\": \"IMAGE NAME\"}' http://localhost:3000/image\n```\n\n## 📝 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpungrumpy%2Fimage-logger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpungrumpy%2Fimage-logger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpungrumpy%2Fimage-logger/lists"}