Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dcefram/fs-routes
Create routes based on the file structure. Works with fastify, express, polkajs, or anything that has the same express-like syntax. Inspired by Next.js' approach for its routes.
https://github.com/dcefram/fs-routes
express fastify nodejs polka router routes
Last synced: about 1 month ago
JSON representation
Create routes based on the file structure. Works with fastify, express, polkajs, or anything that has the same express-like syntax. Inspired by Next.js' approach for its routes.
- Host: GitHub
- URL: https://github.com/dcefram/fs-routes
- Owner: dcefram
- Created: 2020-01-29T10:27:36.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-08-28T06:16:18.000Z (over 1 year ago)
- Last Synced: 2024-10-08T09:32:29.306Z (3 months ago)
- Topics: express, fastify, nodejs, polka, router, routes
- Language: TypeScript
- Homepage:
- Size: 289 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# fs-routes
Inspired by Vercel's Nextjs approach to pages. Also inspired by the "original" [fs-router](https://github.com/jesseditson/fs-router) for [Micro](https://github.com/vercel/micro).
I initially made this for [Polka](https://github.com/lukeed/polka), but it also worked for my newer fastify-based projects when that became a thing.
## Features
- Structure route handlers like serverless functions/lambdas
- Zero dependencies
- Zero configuration
- Path segments
## Installation
```bash
npm i @dcefram/fs-routes
```
## Usage
In your entry file where you created your fastify, polka, or express app:
```javascript
import Fastify from "fastify";
import fsRoutes from "@dcefram/fs-routes";
const fastify = Fastify({ logger: true });
fsRoutes(fastify, "/routes").listen(process.env.PORT, (error) => {
if (error) throw error;
console.log(`API Server running at port ${process.env.PORT}`);
});
```
Folder structure of your app:
```bash
your-app
├── index.js # assuming that this is where you initialized your fastify app
└── routes
└── user
├── [slug]
│ ├── images.js
│ └── comments.js
└── [slug].js
```
Each routes file should have a `module.exports` that exports an object that contains the handlers. Here's an example:
```javascript
const httpErrors = require("http-errors");
module.exports = {
get: (request, reply) => {
const { slug } = req.params;
reply.send({ slug });
},
put: (request, reply) => {
reply.send(httpErrors.NotImplemented());
},
delete: (request, reply) => {
reply.send(httpErrors.NotImplemented());
},
};
```
It could also export the handlers using the ESM format:
```javascript
// OR export
export function get(request, reply) {
const { slug } = req.params;
reply.send({ slug });
}
export function put(request, reply) {
reply.send(httpErrors.NotImplemented());
}
export function delete(request, reply) {
reply.send(httpErrors.NotImplemented());
}
```
With the folder structure above, you'll get the following endpoints:
````bash
GET /user/:slug
PUT /user/:slug
DELETE /user/:slug
GET /user/:slug/images # assuming that images.js has only `get` exported
GET /user/:slug/comments # assuming that comments.js has only `get` exported
### Ignore Files
By default, fs-routes will ignore all files that is prefixed with an underscore (`_`). Example:
```bash
your-app
├── index.js
└── routes
└── user
├── _helpers # This folder will be ignored
│ └── some-reusable-logic.js
├── [slug]
│ ├── images.js
│ ├── comments.js
│ └── _utils.js # This file will be ignored
└── [slug].js
````
You can overwrite the ignore pattern, and supply it with your own. Example:
```javascript
import Fastify from "fastify";
import fsRoutes from "@dcefram/fs-routes";
const fastify = Fastify({ logger: true });
const ignorePattern = "\\.internal\\."; // Will ignore files and folders with ".internal." in its name
fsRoutes(fastify, "/routes", { ignorePattern }).listen(
process.env.PORT,
(error) => {
if (error) throw error;
console.log(`API Server running at port ${process.env.PORT}`);
}
);
```
## Why make this?
I liked how easy it was to navigate through a Next.js-based project. But there are times that we simply want to ship a pure Node.js API without the frontend,
and this is one of the building blocks that I made to make sure that I stay happy building the project.