{"id":20051953,"url":"https://github.com/sixem/ivfi-node","last_synced_at":"2025-08-19T16:32:56.180Z","repository":{"id":42250332,"uuid":"283083367","full_name":"sixem/ivfi-node","owner":"sixem","description":"IVFi is a directory indexer written in Node that aims to make it easy to browse and explore web-accessible directories.","archived":false,"fork":false,"pushed_at":"2024-09-18T04:45:07.000Z","size":1186,"stargazers_count":35,"open_issues_count":8,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-12-13T20:38:31.100Z","etag":null,"topics":["browser","directory-browser","directory-lister","express","files","gallery","indexer","nodejs"],"latest_commit_sha":null,"homepage":"https://git.five.sh/ivfi/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sixem.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":"2020-07-28T03:07:14.000Z","updated_at":"2024-11-06T03:49:09.000Z","dependencies_parsed_at":"2024-04-13T03:23:31.023Z","dependency_job_id":"bf46c5e2-0e29-4f14-bf3c-c75333adceec","html_url":"https://github.com/sixem/ivfi-node","commit_stats":{"total_commits":104,"total_committers":4,"mean_commits":26.0,"dds":0.3942307692307693,"last_synced_commit":"573f5c296717fc81df48623b2a1638e96f174224"},"previous_names":["sixem/nodexer"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sixem%2Fivfi-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sixem%2Fivfi-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sixem%2Fivfi-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sixem%2Fivfi-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sixem","download_url":"https://codeload.github.com/sixem/ivfi-node/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230364000,"owners_count":18214717,"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":["browser","directory-browser","directory-lister","express","files","gallery","indexer","nodejs"],"created_at":"2024-11-13T12:08:34.233Z","updated_at":"2024-12-19T02:06:43.264Z","avatar_url":"https://github.com/sixem.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cbr/\u003e\r\n\u003cdiv align=\"center\"\u003e\r\n\t\u003cimg height=\"100\" src=\"./logo.svg\"\u003e\r\n\t\u003cbr/\u003e\u003cbr/\u003e\r\n\t\u003ch3 align=\"center\"\u003eIVFi-Node\u003c/h3\u003e\r\n\t\u003cp align=\"center\"\u003e\u003ci\u003eThe image and video friendly indexer\u003c/i\u003e\u003c/p\u003e\r\n\u003c/div\u003e\r\n\r\n\u003cbr/\u003e\r\n\r\n\u003cp align=\"center\"\u003e\r\n\u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/v/ivfi?style=flat-square\"\u003e \u003cimg alt=\"Travis (.com)\" src=\"https://img.shields.io/travis/com/sixem/ivfi-node?style=flat-square\"\u003e\r\n\u003c/p\u003e\r\n\r\n\u003cbr/\u003e\r\n\r\n\u003cp align=\"center\"\u003e\r\n\t\u003ca href=\"https://index.five.sh/\"\u003eDemo\u003c/a\u003e\u0026nbsp;\u0026nbsp;\r\n\t\u003ca href=\"https://ivfi.io/docs/node/#/README\"\u003eDocumentation\u003c/a\u003e\u0026nbsp;\u0026nbsp;\r\n\t\u003ca href=\"https://ivfi.io/docs/node/#/configuration\"\u003eConfiguration\u003c/a\u003e\u0026nbsp;\u0026nbsp;\r\n\t\u003ca href=\"https://ivfi.io/docs/node/#/building\"\u003eBuilding\u003c/a\u003e\r\n\u003c/p\u003e\r\n\u003cbr/\u003e\r\n\r\n# About\r\nIVFi-Node is a file directory browser script made in Node and TypeScript.\r\n\r\nIt is designed to be a comprehensive indexer, with a focus on efficiently handling image and video files. IVFi has a modern and user-friendly interface, offering features such as a gallery view, hoverable previews, and many customization options.\r\n\r\nThis project can be easily set up on most web servers.\r\n\r\n\u003cbr/\u003e\r\n\r\n# Quick setup :zap:\r\n### Install via npm\r\n```shell\r\nnpm install ivfi\r\n```\r\n\r\n## Usage\r\nImport (or require) package:\r\n```js\r\nimport ivfi from 'ivfi';\r\n```\r\nBasic initialization example:\r\n```js\r\nconst port = 3000;\r\nconst directory = '/var/www/html/';\r\nconst options = {};\r\n    \r\n(async () =\u003e\r\n{\r\n    /** Start server */\r\n    const server = await ivfi.run(port, directory, options);\r\n})();\r\n```\r\nThis will spin up a webserver on `http://localhost:3000/` with the path set to `/var/www/html/`.\r\n\r\nA documentation of the available options can be found [here](https://ivfi.io/docs/node/#/configuration).\r\n\r\n# Development\r\n\r\nClone the repository and install the required `npm` packages:\r\n```shell\r\ngit clone https://github.com/sixem/ivfi-node\r\ncd ivfi-node\r\nnpm install\r\n```\r\nCreate a `run.ts` file with a simple initialization of the script:\r\n```js\r\nimport ivfi from './src/index';\r\n\r\nconst port = 3000;\r\nconst directory = '/var/www/html/';\r\n\r\nconst server = ivfi(__dirname);\r\n\r\nserver.run(port, directory, {\r\n\tdebug: true\r\n});\r\n```\r\nBuild the `dist` files that are used on the client side:\r\n```bash\r\nnpm run compile:development\r\n```\r\nStart the server:\r\n```js\r\nnode --loader ts-node/esm run.ts\r\n```\r\nAny changes made to the client side code, will require a recompiled `dist` directory, while any changes made to the server side code will simply require a restart of the server.\r\n\r\n# Building\r\nTo package the project:\r\n```bash\r\nnpm run transpile:pack\r\n```\r\nThis will create a new directory with the packaged script.\r\n\r\n## Other Projects\r\nThis is a Node version of the image and video friendly indexer (IVFi).\r\n\r\nFor other non-node versions, see: [https://ivfi.io/](https://ivfi.io/)\r\n## Disclaimer\r\nAs always, use this script at your own risk. There may exist bugs that i do not know of.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsixem%2Fivfi-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsixem%2Fivfi-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsixem%2Fivfi-node/lists"}