routenest
TypeScript icon, indicating that this package has built-in type declarations

0.1.1 • Public • Published

🌐 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

  1. Import the library:
import routeNest from 'routenest'
  1. Organize your routes in a directory (e.g., /api):
/api
  /users
    get.js
    post.js
    /[id]
      get.js
      put.js
  1. 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.

Package Sidebar

Install

npm i routenest

Weekly Downloads

1

Version

0.1.1

License

MIT

Unpacked Size

9.88 kB

Total Files

5

Last publish

Collaborators

  • cantemizyurek