# Welcome!

#### What is this API template?

***

This is a highly customizable API template designed to give developers a solid foundation for building scalable and modern server architectures using Node.js. The template starts with a **free base** version that covers all essential elements to get your project up and running. As your needs grow, you can integrate **premium modules** to extend its functionality.

#### Why use this API template?

***

* **Free and flexible**: The base version is free and includes a professional project structure, along with MySQL database integration, making it easy to start your project.
* **Scalable**: As your project grows, premium modules (like HTTPS and WebSocket integration) can be added seamlessly to meet your expanding needs.
* **Customizable**: While the template provides strong patterns to help you get started, it's built with flexibility in mind, allowing you to customize and extend the logic to suit your specific requirements.
* **Modern practices**: The template follows best practices for modern Node.js development, helping you build a project that is both maintainable and future-proof.

#### Economic Model

***

The API template is offered in two tiers, with the ability to extend the premium version as your project grows:

### Free Version (Template - Free):

The free version provides a basic template built with **Node.js** using **ExpressJS**. It includes the fundamental structure to get you started with a Node.js API, but no additional modules or features are available in this version.

### Premium Version (Template - Premium):

The premium version is a paid, full-featured template built with **NestJS**, offering a complete and secure architecture. It implements essential features, with a focus on security and performance. This template is highly extensible, allowing you to integrate additional paid modules that can be easily plugged into the API as your project evolves.

With this approach, you can start small and scale with additional modules as your project requirements evolve, allowing you to only pay for the features you need when you need them.

***

Please note that **modules are not compatible with the free version**.

With this structure, you get a solid, scalable backend that can grow alongside your project, with the option to purchase and integrate only the features you need when you need them.

{% hint style="info" %}
[Remember, this template is designed to give you a solid starting point. The rest is in your hands to adapt it and expand it according to the specific needs of your project.](#user-content-fn-1)[^1]
{% endhint %}

[^1]:


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://gruntsass.gitbook.io/template-api-nodejs/welcome.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
