{"id":19994209,"url":"https://github.com/b4dnewz/micro-fs-router","last_synced_at":"2026-05-10T13:46:38.598Z","repository":{"id":37817880,"uuid":"223268124","full_name":"b4dnewz/micro-fs-router","owner":"b4dnewz","description":"A micro plugin that leverage the filesystem","archived":false,"fork":false,"pushed_at":"2023-01-05T01:25:18.000Z","size":784,"stargazers_count":1,"open_issues_count":13,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-12T12:30:34.460Z","etag":null,"topics":["http-server","micro","micro-plugin","microservice","microservice-template","microservices","microservices-architecture","nodejs","nodejs-server"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/b4dnewz.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}},"created_at":"2019-11-21T21:24:08.000Z","updated_at":"2024-08-06T03:06:00.000Z","dependencies_parsed_at":"2023-02-03T03:46:12.218Z","dependency_job_id":null,"html_url":"https://github.com/b4dnewz/micro-fs-router","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b4dnewz%2Fmicro-fs-router","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b4dnewz%2Fmicro-fs-router/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b4dnewz%2Fmicro-fs-router/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/b4dnewz%2Fmicro-fs-router/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/b4dnewz","download_url":"https://codeload.github.com/b4dnewz/micro-fs-router/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241435151,"owners_count":19962401,"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":["http-server","micro","micro-plugin","microservice","microservice-template","microservices","microservices-architecture","nodejs","nodejs-server"],"created_at":"2024-11-13T04:54:20.168Z","updated_at":"2026-05-10T13:46:33.559Z","avatar_url":"https://github.com/b4dnewz.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# micro-fs-router\n\n\u003e A micro plugin that leverage the filesystem\n\n[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage percentage][coveralls-image]][coveralls-url]\n\n## Features\n\n- Works out of the box with zero config\n- Automatically parse request query, params and body\n- Can be extended with a compose function\n- Support route params, nested routes, ...\n\n## Getting started\n\nInstall the project using your favourite package manager.\n\n```\nnpm install micro-fs-router\n```\n\nImport the module in your main script and run it with the routes path.\n\n```js\nimport microFsRouter from \"micro-fs-router\";\n\nconst router = microFsRouter(\"./routes\");\n\nexport default router;\n```\n\nInside the `routes` folder a file called _hello.js_ with a micro function.\n\n```js\nexport default function({ query }) {\n    return `Hello, ${query.name || \"micro\"}`;\n}\n```\n\nNow run it with __micro__ and try to access the service.\n\n```\n$ npx micro index.js\n```\n\n```\n$ curl http://localhost:3000/hello\nHello, micro\n\n$ curl http://localhost:3000/hello?name=test\nHello, test\n```\n\n## Contributing\n\n1. Create an issue and describe your idea\n2. Fork the project (https://github.com/b4dnewz/micro-fs-router/fork)\n3. Create your __feature branch__ (`git checkout -b my-new-feature`)\n4. Commit your changes with logic (`git commit -am 'Add some feature'`)\n5. Publish the branch (`git push origin my-new-feature`)\n6. Add __some test__ for your new feature\n7. Create a new Pull Request\n\n---\n\n## License\n\nMade with love and [MIT](./LICENSE) license © [Filippo Conti](https://b4dnewz.github.io/)\n\n[npm-image]: https://badge.fury.io/js/micro-fs-router.svg\n[npm-url]: https://npmjs.org/package/micro-fs-router\n[travis-image]: https://travis-ci.org/b4dnewz/micro-fs-router.svg?branch=master\n[travis-url]: https://travis-ci.org/b4dnewz/micro-fs-router\n[coveralls-image]: https://coveralls.io/repos/b4dnewz/micro-fs-router/badge.svg\n[coveralls-url]: https://coveralls.io/r/b4dnewz/micro-fs-router","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fb4dnewz%2Fmicro-fs-router","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fb4dnewz%2Fmicro-fs-router","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fb4dnewz%2Fmicro-fs-router/lists"}