![\"npm](\"https://badge.fury.io/js/18h.svg\"){kind=icon}
\n\t\n ![](\"https://img.shields.io/github/license/ridafkih/18h\")
\n \n\t ![](\"https://img.shields.io/github/followers/ridafkih?logo=github&style=social&label=Follow\")
\n \n \n\t ![](\"https://img.shields.io/twitter/follow/ridafkih?label=Follow\")
\n \n![](\"https://i.imgur.com/jWLjU1R.png\")
\n\n18h is a Next.js-inspired Koa-router wrapper, which allows you to create routes that match the pattern of your filesystem. This speeds up iteration, while maintaining a serverful architecture.
\nThis library is best used with Node.js & TypeScript in order to unlock all the type-safety capabilities it has to offer.
\n\nThat is how long Koala's sleep, and all the cooler names were taken.
\n\nGetting started is pretty snappy.
\n\nIn order to install the package, in your root directory simply use your favourite package manager in order to install the package. It is registered on the NPM under the name 18h.
First, using your favourite file manager, or the command line, create the folder in which your routes will be stored in. This folder will mirror the structure of your API.
\n\n```bash\nmkdir routes\n```\n\nOnce this is complete, we will be able to instantiate our router object by referencing this folder. It's best practice to use the Node.js path module, along with the global __dirname constant in order to ensure the application runs correctly once it is transpiled to JavaScript.
We can also instantiate the 18h router with global middleware that will run prior to every API call.
\n\n```ts\nconst logRequest = async (context, next) => {\n console.log(context);\n await next();\n};\n\nrouter({\n // ...\n middleware: [logRequest],\n});\n```\n\nIts important to remember that the structure of the filesystem within the routes folder you provide as the routesFolder key is going to mirror the structure of your URLs.
Of course, we want the paths to do things when someone interacts with them, that logic is defined in RouteController object, which takes multiple MethodControllers in which we define the logic of that endpoint.
Let's start off by creating the logic for the /users/[userId]/block endpoint so we can get a better feel for all the features.