0.1.1 ā¢ Published 8 months ago
routenest v0.1.1
š routeNest
š Easily structure and manage your Express.js routes using a directory-based approach. š
š¦ Installation
npm install routenest
š Features
š Automatic Express route generation based on directory structure.
āļø Supports middlewares and RESTful methods.
š² Clean and organized route management using a tree structure.
š Usage
- Import the library:
import routeNest from 'routenest'
- Organize your routes in a directory (e.g., /api):
/api
/users
get.js
post.js
/[id]
get.js
put.js
- Initialize with your routes directory:
const app = routeNest.initExpress('/api')
app.listen(3000)
š” By default, routeNest looks into the /api directory, but you can customize the directory path by passing it to initExpress.
š API
initExpress(directoryPath: string)
š Initializes the Express application with routes and middlewares defined in the provided directory.
Parameters:
directoryPath
: (Optional) The path to the directory containing your routes. Defaults to/api
.
Returns:
- An initialized Express application.
š¤ Contributing
If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.
š License
This project is licensed under the MIT License.