Example

Metarhia Application Example for Node.js

The Metarhia Application Example is a robust project designed for developers working with Node.js. This example serves as an advanced version of the Node.js Starter Kit, employing the Metarhia technology stack to move all system code into dependencies. The project's main goal is to guide developers in leveraging best practices with Metarhia and Metaserverless technologies. In essence, it offers a practical structure and architecture while demonstrating the ease and effectiveness of these technologies for software development.

Key Features

This project is packed with features that act as a benchmark for building efficient Node.js applications using the Metarhia stack:

• Serve API with Auto Routing: Handles HTTP(S) and WebSockets (WS(S)) effortlessly by automatically configuring routes.
• Server Live Reload: Uses filesystem monitoring to reload server code without manual intervention.
• Automatic Dependency Loader: Simplifies project startup by managing plugins and dependencies automatically.
• Graceful Shutdowns and Reloads: Ensures the application stops and restarts seamlessly without data loss.
• Optimized Code Base: Maintains minimal code size and dependencies to improve application performance.
• Code Sandboxing: Enhances security by isolating code execution environments.
• Multi-threading Support: Improves CPU utilization by distributing tasks across multiple threads.
• Static File Serving with Cache: Accelerates file delivery by caching content in memory.
• Robust Configuration System: Offers easy-to-manage application settings.
• Basic Logging and Console Redirection: Provides simple logging mechanisms to track application activities.
• Database Access with PostgreSQL: Facilitates data storage and retrieval through an integrated database layer.
• Persistent Client Sessions: Maintains user sessions across application interactions.
• Testing Examples: Includes unit and API tests to ensure code quality and reliability.
• Request Management: Implements queue timeouts and size limits to manage incoming requests more effectively.
• Parallel API Execution: Executes concurrent requests without performance bottlenecks.
• Method Execution Timeouts: Sets limits on API method runtime to enhance application responsiveness.
• Load Balancing: Distributes workload effectively to scale application resources.
• Prototype Pollution Prevention: Guards against vulnerabilities in the application code.
• Enhanced Code Isolation: Provides better separation of concerns for improved modularity.

How to Use

To get started with the Metarhia Application Example, developers should be equipped with Node.js version 18.x or 20.x. The following steps will initiate the project:

1. Fork and clone the repository to access the project files.
2. Use the command npm i to install necessary dependencies and create an RSA certificate.
3. Customize your project by removing unnecessary dependencies and adding your license information.
4. Modify the starter kit as needed to tailor it to your project objectives.
5. For those with Docker, launch the project using docker-compose up.
6. Set up the database before running the server. Ensure PostgreSQL (version 12.x to 16.x) is installed and run the database initialization script using database/setup.sh.
7. Launch the project with node server.js. To stop the server, use Ctrl+C.

The project encourages developer engagement via Telegram with two relevant channels for Node.js and Metarhia-related queries.

License

The project is licensed under the MIT License, which means contributors and users are free to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software, provided the original license details are retained. This license empowers developers to adapt the project to their needs without legal constraints.

Overall, the Metarhia Application Example is a comprehensive guide for developers looking to explore and implement advanced Node.js applications efficiently.