Package Exports
- xypriss
- xypriss/package.json
Readme
XyPriss
Enterprise-Grade Node.js Web Framework
Overview
XyPriss is a TypeScript-first Node.js web framework designed for building secure, scalable, and high-performance web applications. Built with enterprise requirements in mind, XyPriss provides comprehensive security features, advanced clustering capabilities, and seamless integration with production infrastructure.
Core Features
- Security-First Architecture - 12+ built-in security middleware modules including CSRF protection, XSS prevention, and intelligent rate limiting
- High Performance - Independent HTTP server implementation with multi-core clustering support
- File Upload Management - Production-ready multipart/form-data handling with automatic validation and error handling
- Extensible Plugin System - Permission-based plugin architecture with lifecycle hooks and security controls
- Multi-Server Support - Run multiple server instances with isolated configurations and security policies
- Production Integration - Native integration with XyNginC for automated Nginx configuration and SSL management
Installation
npm install xypriss
# or
yarn add xyprissFor additional security features:
npm install xypriss-securityQuick Start
Using CLI
npx xypriss-cli init
cd my-app
npm run devManual Setup
import { createServer } from "xypriss";
const app = createServer({
server: { port: 3000 },
security: { enabled: true },
});
app.get("/", (req, res) => {
res.json({ message: "Hello from XyPriss" });
});
app.start();Documentation
Getting Started
- Quick Start Guide - Installation and basic setup
- Examples - Practical code examples
- Features Overview - Comprehensive feature list
Core Guides
- Routing - Route configuration and middleware
- Security - Security features and best practices
- File Upload - File upload handling
- Configuration - Complete configuration reference
- Multi-Server - Multi-server deployment
Plugin System
- Plugin Development - Creating plugins
- Plugin Hooks - Available lifecycle hooks
- Plugin Permissions - Security and permissions
- Console Intercept Hook - Console monitoring
Advanced Topics
- XJson API - Advanced JSON serialization
- Clustering - Multi-worker scaling
- Performance Tuning - Optimization strategies
Security
XyPriss is built with security as a fundamental design principle. The framework implements multiple layers of protection and follows industry best practices for secure web application development.
Security Disclosure Policy
While we maintain rigorous security standards, we acknowledge that vulnerabilities may exist. We encourage responsible disclosure of security issues.
If you discover a security vulnerability, please report it via email:
Email: support@team.nehonix.com
Please do not open public GitHub issues for security vulnerabilities.
We are committed to:
- Acknowledging receipt of your report within 48 hours
- Providing regular updates on our progress
- Crediting researchers who responsibly disclose vulnerabilities
Your assistance in maintaining the security of XyPriss is greatly appreciated.
Contributing
XyPriss is an open-source project that welcomes contributions from the community. We value all forms of contribution, from bug reports to documentation improvements.
How to Contribute
- Star the Repository - Show your support and help others discover XyPriss
- Report Issues - Submit bug reports with detailed reproduction steps
- Suggest Features - Open discussions for feature proposals
- Submit Pull Requests - Review our Contributing Guide before submitting code
- Improve Documentation - Help us maintain clear and accurate documentation
Contribution Guidelines
- Follow the existing code style and conventions
- Include tests for new features
- Update documentation as needed
- Ensure all tests pass before submitting
- Write clear commit messages
Read the Complete Contributing Guide
Community Support
Resources
- Documentation - Complete guides and API reference
- GitHub Discussions - Community Q&A and feature discussions
- Issue Tracker - Bug reports and feature requests
- Security - Report vulnerabilities
- Website - Learn more about Nehonix
Support the Project
If XyPriss has been valuable for your projects, consider:
- Starring the repository on GitHub
- Sharing the project with your network
- Contributing to the codebase or documentation
- Providing feedback and suggestions
License
XyPriss is licensed under the NOSL License.