Vulppi - IntREST - BETA

Attention: Please note that the current version of this framework is in the beta stage and is not recommended for production use. We advise you to wait for the stable release before using it in a production environment.

We are working hard to deliver a stable and reliable framework for your backend development needs.

In the meantime, you are welcome to explore and experiment with the beta version for testing and evaluation purposes. Your feedback and suggestions during this phase will be greatly appreciated as they can help us enhance and improve the framework before the final release.

Thank you for your understanding and support as we work towards delivering a high-quality framework for your programming needs.

Table of Contents

1. Introduction
   1. Key Features
   2. Future Features
2. Documentation
   1. Getting Started
   2. Core Concepts
   3. Usage Guide
   4. Configuration
   5. API Reference
   6. Troubleshooting
   7. Best Practices and Tips
3. Contributing and Community
4. License
5. Contact

Introduction

IntREST is a versatile backend framework written in TypeScript, specifically tailored for Node.js (version >= 18.0.0). It provides a range of tools and utilities that streamline the development of RESTful APIs. By employing a file-system-based approach, IntREST simplifies route handling by mapping the application's routes to its file structure, enhancing code organization and promoting simplicity.

Key Features

• Thread Workers: Divides requests into thread workers pool, optimizing resource utilization and improving overall performance.
• RESTful API Development: Simplifies the process of building robust and efficient RESTful APIs.
• File-System Based Routing: Routes within the application are determined by the file structure, ensuring a clean and intuitive approach to defining API endpoints.
• Performance and Scalability: Enhances the performance and scalability of Node.js applications, accommodating high volumes of traffic seamlessly.
• CORS Handling: Automatically manages Cross-Origin Resource Sharing (CORS) requests, simplifying integration with external clients.
• Request Parsing: Automatically detects and parses JSON, XML, URL-encoded and Multipart requests, eliminating the need for manual parsing.
• Response Type Detection: Intelligently identifies the response type, supporting JSON, Buffer, String, or ReadableStream, facilitating integration with various client applications.

With IntREST, you can expedite your backend development, streamline code organization through file-system-based routing, and deliver high-performance RESTful APIs effortlessly. Let's delve into the details of utilizing this framework to harness its true potential.

Future Features

• Easy handlers for Authentication and Authorization
  • JWT
  • OAuth
  • Providers (Google, Facebook, Twitter, Github, etc.)
  • FIDO2
• Auto validation
  • Request Validation
  • Response Validation
• Auto documentation
  • OpenAPI
• Swagger UI for testing
• Performance monitoring
• Logging
• Error handling
• HTTP2.0
• Deployment
  • Edge functions
  • Serverless functions

Documentation

1. Getting Started
2. Core Concepts
3. Usage Guide
4. Configuration
5. API Reference
6. Troubleshooting
7. Best Practices and Tips

Contributing and Community

Contributions are welcome! If you want to contribute to IntREST, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive messages.
4. Push your changes to your forked repository.
5. Submit a pull request to the main repository.
6. And that's it! We will review your pull request as soon as possible.
7. Thank you for contributing to IntREST! 🎉
8. If you have any questions, feel free to contact us.
9. If you want to contribute more, you can Buy Us a Coffee ☕️

License

This project is licensed under the MIT License.

Contact

For any inquiries or questions, you can reach out to the author:

Renato Rodrigues
Email: [email protected]

Thank you for using IntREST! We hope it helps you build powerful and scalable Node.js applications. If you have any feedback or suggestions, feel free to let us know.

Visit the Vulppi organization site for more information about our projects and services.