diff --git a/templates/app-esm/routes/README.md b/templates/app-esm/routes/README.md index fd8d0b2a..75b5658c 100644 --- a/templates/app-esm/routes/README.md +++ b/templates/app-esm/routes/README.md @@ -1,8 +1,10 @@ # Routes Folder -Routes define routes within your application. Fastify provides an -easy path to a microservice architecture, in the future you might want -to independently deploy some of those. +Routes define the pathways within your application. +Fastify's structure supports the modular monolith approach, where your +application is organized into distinct, self-contained modules. +This facilitates easier scaling and future transition to a microservice architecture. +In the future you might want to independently deploy some of those. In this folder you should define all the routes that define the endpoints of your web application. @@ -13,7 +15,7 @@ typically stored in a file; be careful to group your routes logically, e.g. all `/users` routes in a `users.js` file. We have added a `root.js` file for you with a '/' root added. -If a single file become too large, create a folder and add a `index.js` file there: +If a single file becomes too large, create a folder and add a `index.js` file there: this file must be a Fastify plugin, and it will be loaded automatically by the application. You can now add as many files as you want inside that folder. In this way you can create complex routes within a single monolith, diff --git a/templates/app-ts-esm/src/routes/README.md b/templates/app-ts-esm/src/routes/README.md index 9d209026..75b5658c 100644 --- a/templates/app-ts-esm/src/routes/README.md +++ b/templates/app-ts-esm/src/routes/README.md @@ -1,8 +1,10 @@ # Routes Folder -Routes define endpoints within your application. Fastify provides an -easy path to a microservice architecture, in the future you might want -to independently deploy some of those. +Routes define the pathways within your application. +Fastify's structure supports the modular monolith approach, where your +application is organized into distinct, self-contained modules. +This facilitates easier scaling and future transition to a microservice architecture. +In the future you might want to independently deploy some of those. In this folder you should define all the routes that define the endpoints of your web application. @@ -13,7 +15,7 @@ typically stored in a file; be careful to group your routes logically, e.g. all `/users` routes in a `users.js` file. We have added a `root.js` file for you with a '/' root added. -If a single file become too large, create a folder and add a `index.js` file there: +If a single file becomes too large, create a folder and add a `index.js` file there: this file must be a Fastify plugin, and it will be loaded automatically by the application. You can now add as many files as you want inside that folder. In this way you can create complex routes within a single monolith, @@ -22,3 +24,6 @@ and eventually extract them. If you need to share functionality between routes, place that functionality into the `plugins` folder, and share it via [decorators](https://fastify.dev/docs/latest/Reference/Decorators/). + +If you're a bit confused about using `async/await` to write routes, you would +better take a look at [Promise resolution](https://fastify.dev/docs/latest/Reference/Routes/#promise-resolution) for more details. diff --git a/templates/app-ts/src/app.ts b/templates/app-ts/src/app.ts index 58aabb66..be51f922 100644 --- a/templates/app-ts/src/app.ts +++ b/templates/app-ts/src/app.ts @@ -31,7 +31,6 @@ const app: FastifyPluginAsync = async ( dir: join(__dirname, 'routes'), options: opts }) - }; export default app; diff --git a/templates/app-ts/src/routes/README.md b/templates/app-ts/src/routes/README.md index 9d209026..084748f8 100644 --- a/templates/app-ts/src/routes/README.md +++ b/templates/app-ts/src/routes/README.md @@ -1,7 +1,10 @@ # Routes Folder -Routes define endpoints within your application. Fastify provides an -easy path to a microservice architecture, in the future you might want +Routes define the pathways within your application. +Fastify's structure supports the modular monolith approach, where your +application is organized into distinct, self-contained modules. +This facilitates easier scaling and future transition to a microservice architecture. +In the future you might want to independently deploy some of those. In this folder you should define all the routes that define the endpoints @@ -13,7 +16,7 @@ typically stored in a file; be careful to group your routes logically, e.g. all `/users` routes in a `users.js` file. We have added a `root.js` file for you with a '/' root added. -If a single file become too large, create a folder and add a `index.js` file there: +If a single file becomes too large, create a folder and add a `index.js` file there: this file must be a Fastify plugin, and it will be loaded automatically by the application. You can now add as many files as you want inside that folder. In this way you can create complex routes within a single monolith, @@ -22,3 +25,6 @@ and eventually extract them. If you need to share functionality between routes, place that functionality into the `plugins` folder, and share it via [decorators](https://fastify.dev/docs/latest/Reference/Decorators/). + +If you're a bit confused about using `async/await` to write routes, you would +better take a look at [Promise resolution](https://fastify.dev/docs/latest/Reference/Routes/#promise-resolution) for more details. diff --git a/templates/app/routes/README.md b/templates/app/routes/README.md index 3fe1becf..75b5658c 100644 --- a/templates/app/routes/README.md +++ b/templates/app/routes/README.md @@ -1,8 +1,10 @@ # Routes Folder -Routes define routes within your application. Fastify provides an -easy path to a microservice architecture, in the future you might want -to independently deploy some of those. +Routes define the pathways within your application. +Fastify's structure supports the modular monolith approach, where your +application is organized into distinct, self-contained modules. +This facilitates easier scaling and future transition to a microservice architecture. +In the future you might want to independently deploy some of those. In this folder you should define all the routes that define the endpoints of your web application.