{"id":21155267,"url":"https://github.com/nlfmt/local-file-server","last_synced_at":"2025-04-13T12:29:11.583Z","repository":{"id":130781571,"uuid":"500260147","full_name":"nlfmt/local-file-server","owner":"nlfmt","description":"Quickly serve files from a directory to all computers on your local network. Navigate that directory with an easy-to-use web interface, click any file to download.","archived":false,"fork":false,"pushed_at":"2022-06-14T18:03:46.000Z","size":58,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-12T12:57:55.834Z","etag":null,"topics":["cross-platform","expressjs","filesystem","javascript","server","sharing"],"latest_commit_sha":null,"homepage":"","language":"HTML","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/nlfmt.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}},"created_at":"2022-06-06T01:55:30.000Z","updated_at":"2025-03-15T14:57:19.000Z","dependencies_parsed_at":"2023-07-08T01:01:08.284Z","dependency_job_id":null,"html_url":"https://github.com/nlfmt/local-file-server","commit_stats":{"total_commits":6,"total_committers":1,"mean_commits":6.0,"dds":0.0,"last_synced_commit":"327b78fcf1c7eceed6f5cf30a14683330549ecf9"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nlfmt%2Flocal-file-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nlfmt%2Flocal-file-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nlfmt%2Flocal-file-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nlfmt%2Flocal-file-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nlfmt","download_url":"https://codeload.github.com/nlfmt/local-file-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248713816,"owners_count":21149784,"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":["cross-platform","expressjs","filesystem","javascript","server","sharing"],"created_at":"2024-11-20T11:17:02.441Z","updated_at":"2025-04-13T12:29:11.560Z","avatar_url":"https://github.com/nlfmt.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Local File Server\n\nQuickly serve files from a directory to all computers on your local network.\\\nNavigate that directory with an easy-to-use web interface, click any file to download.\n\n\n![example](https://user-images.githubusercontent.com/71983360/172081819-2e0ea5b4-c423-48be-9e1c-517e1d5af301.png)\n\n\n\n## Installation *(with binaries)*\n\n1. Download the binaries from the [releases page](https://github.com/nlfmt/local-file-server/releases).\n\n2. Extract the binaries into any directory.\n3. For Linux \u0026 Mac OS X you need to turn the binary into an executable.\n\n    ```sh\n    chmod +x serve\n    ```\n\n4. Add the right binary to your `PATH` environment variable.\\\n    On Linux, you can also use `ln -s /path/to/serve /usr/local/bin/serve`\n\n\n## Installation *(with nodejs \u0026 start script)*\n\n1. Clone this repository to your computer.\n\n    ```sh\n    git clone https://github.com/nlfmt/local-file-server.git\n    ```\n\n2. Install the dependencies.\n\n    ```sh\n    cd local-file-server\n\n    npm i   # installs express \u0026 pkg modules\n    ```\n\n3. Optionally add the script folder to your PATH.\n\n\n## Usage\nYou can run the server with `npm start` or `node main.js`, but in this example\\\nwe'll assume you have added the `serve` script to your PATH.\n\n```bash\nserve                # serve the current directory on port 3000\nserve . 8000         # serve the current directory on the given port\nserve /path/to       # serve the given directory on port 3000\nserve /path/to 8000  # serve the given directory on the given port\n```\n\n## Building\n\nIf you want to build the executables yourself, you need to:\n - install [nodejs](https://nodejs.org/en/)\n - install npm (usually included with nodejs)\n\nthen run the following commands:\n\n```sh\nnpm i                   # installs express \u0026 pkg modules\nnpm run build           # builds win, mac \u0026 linux binaries to ./build\n\n# You can also only build for one platform:\nnpm run build:win       # builds win binary to ./build/win\nnpm run build:mac       # builds mac binary to ./build/mac\nnpm run build:linux     # builds linux binary to ./build/linux\n```\n\n\n## Issues \u0026 Improvement Ideas\n\nIf you have any issues or ideas, please [open an issue](https://github.com/nlfmt/local-file-server/issues).\n\n\n## License\nThis Project uses the MIT License, see the [LICENSE](https://github.com/nlfmt/local-file-server/blob/master/LICENSE) file for more information.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnlfmt%2Flocal-file-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnlfmt%2Flocal-file-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnlfmt%2Flocal-file-server/lists"}