|
1 | 1 | --- |
2 | 2 | title: Introduction |
3 | | -description: Welcome to Nuxt UI documentation template. |
4 | | -navigation: |
5 | | - icon: i-lucide-house |
| 3 | +description: A modern, efficient, and flexible JavaScript server framework that runs anywhere with unmatched performance and complete configurability. |
6 | 4 | --- |
7 | 5 |
|
8 | | -This template is a ready-to-use documentation template made with [Nuxt UI](https://ui.nuxt.com) to create beautiful & responsive Nuxt applications in minutes. |
9 | | - |
10 | | -There are already many websites based on this template: |
11 | | - |
12 | | -::card-group |
13 | | - :::card |
14 | | - --- |
15 | | - icon: i-simple-icons-nuxtdotjs |
16 | | - target: _blank |
17 | | - title: Nuxt |
18 | | - to: https://nuxt.com |
19 | | - --- |
20 | | - The Nuxt website |
21 | | - ::: |
22 | | - |
23 | | - :::card |
24 | | - --- |
25 | | - icon: i-simple-icons-nuxtdotjs |
26 | | - target: _blank |
27 | | - title: Nuxt UI |
28 | | - to: https://ui.nuxt.com |
29 | | - --- |
30 | | - The documentation of `@nuxt/ui` |
31 | | - ::: |
32 | | - |
33 | | - :::card |
34 | | - --- |
35 | | - icon: i-simple-icons-nuxtdotjs |
36 | | - target: _blank |
37 | | - title: Nuxt Image |
38 | | - to: https://image.nuxt.com |
39 | | - --- |
40 | | - The documentation of `@nuxt/image` |
41 | | - ::: |
42 | | - |
43 | | - :::card |
44 | | - --- |
45 | | - icon: i-simple-icons-nuxtdotjs |
46 | | - target: _blank |
47 | | - title: Nuxt Content |
48 | | - to: https://content.nuxt.com |
49 | | - --- |
50 | | - The documentation of `@nuxt/content` |
51 | | - ::: |
52 | | - |
53 | | - :::card |
54 | | - --- |
55 | | - icon: i-simple-icons-nuxtdotjs |
56 | | - target: _blank |
57 | | - title: Nuxt Devtools |
58 | | - to: https://devtools.nuxt.com |
59 | | - --- |
60 | | - The documentation of `@nuxt/devtools` |
61 | | - ::: |
62 | | - |
63 | | - :::card |
64 | | - --- |
65 | | - icon: i-simple-icons-nuxtdotjs |
66 | | - target: _blank |
67 | | - title: Nuxt Hub |
68 | | - to: https://hub.nuxt.com |
69 | | - --- |
70 | | - The best place to manage your projects, environments and variables. |
71 | | - ::: |
72 | | -:: |
73 | | - |
74 | | -## Key Features |
75 | | - |
76 | | -This template includes a range of features designed to streamline documentation management: |
77 | | - |
78 | | -- **Powered by** [**Nuxt**](https://nuxt.com): Utilizes the latest Nuxt framework for optimal performance. |
79 | | -- **Built with** [**Nuxt UI**](https://ui.nuxt.com): Integrates a comprehensive suite of UI components. |
80 | | -- [**MDC Syntax**](https://content.nuxt.com/usage/markdown) **via** [**Nuxt Content**](https://content.nuxt.com): Supports Markdown with component integration for dynamic content. |
81 | | -- **Auto-generated Sidebar Navigation**: Automatically generates navigation from content structure. |
82 | | -- **Full-Text Search**: Includes built-in search functionality for content discovery. |
83 | | -- **Optimized Typography**: Features refined typography for enhanced readability. |
84 | | -- **Dark Mode**: Offers dark mode support for user preference. |
85 | | -- **Extensive Functionality**: Explore the template to fully appreciate its capabilities. |
| 6 | +## Motivation |
| 7 | + |
| 8 | +Modern JavaScript applications often require complex architectures that enable the creation of scalable and maintainable systems. Existing frameworks like Express or Koa provide basic functionality but typically require additional libraries and configuration to achieve a modern application architecture. |
| 9 | + |
| 10 | +[Routing-controllers](https://github.com/typestack/routing-controllers) was a step in the right direction, introducing a decorator and class-based approach, but with the evolution of the JavaScript/TypeScript ecosystem and the emergence of new standards and runtimes (Bun, Deno), there was a need to create a new solution that: |
| 11 | + |
| 12 | +- Fully utilizes the capabilities of the latest versions of TypeScript and JavaScript |
| 13 | +- Offers configuration flexibility while maintaining ease of use |
| 14 | +- Provides high performance without unnecessary overhead |
| 15 | +- Is compatible with various JavaScript runtime environments |
| 16 | +- Supports both ESM and CommonJS |
| 17 | +- Ensures excellent developer experience (DX) |
| 18 | + |
| 19 | +These needs were the direct inspiration for creating Vercube—a modern, efficient, and flexible framework that solves the problems of existing solutions while offering new possibilities. |
| 20 | + |
| 21 | +## What is Vercube? |
| 22 | + |
| 23 | +Vercube is a modern JavaScript framework based on the object-oriented programming (OOP) paradigm and TypeScript decorators, enabling the creation of server applications in an elegant and type-safe manner. The framework is built from the ground up using native Request and Response interfaces without relying on any additional HTTP frameworks, which ensures exceptional performance, low resource usage, and runtime agnosticism. Vercube seamlessly runs on different JavaScript environments (Node.js, Bun, Deno) by leveraging native interfaces common across all modern runtimes. |
| 24 | + |
| 25 | +Key features of Vercube: |
| 26 | + |
| 27 | +- **Declarative routing** — thanks to TypeScript decorators, you can declare API endpoints in a readable and concise way |
| 28 | +- **Dependency Injection** — built-in dependency injection system that facilitates code organization and testing |
| 29 | +- **Runtime agnostic** — works independently across all runtime environments (Node.js, Bun, Deno) using native interfaces |
| 30 | +- **Modularity** — flexible architecture that allows for creating modular applications |
| 31 | +- **Zero-config** — default configurations that allow for quick start without unnecessary setup |
| 32 | +- **Type safety** — full support for TypeScript that ensures type safety at all levels of the application |
| 33 | +- **Support for ESM and CommonJS** — compatibility with both module systems |
| 34 | +- **High performance** — optimized architecture using direct Request/Response handling for exceptional speed and minimal resource usage |
| 35 | + |
| 36 | +Vercube can be seen as a modern evolution of the concepts introduced by routing-controllers, but with better implementation, support for the latest standards, and much greater flexibility. |
| 37 | + |
| 38 | +## Why Vercube? |
| 39 | + |
| 40 | +In the JavaScript ecosystem, there are many frameworks such as [Express](https://expressjs.com/), [Koa](https://koajs.com/), [Fastify](https://fastify.dev/), [NestJS](https://nestjs.com/), [Routing-Controllers](https://github.com/typestack/routing-controllers), or [Ts.ED](https://tsed.dev/). So why choose Vercube? Here are the main reasons: |
| 41 | + |
| 42 | +### Performance without compromise |
| 43 | + |
| 44 | +Vercube has been designed with performance as the absolute priority from the very beginning. Built on native Request and Response interfaces with zero middleware overhead, it delivers unmatched speed and minimal latency across all runtime environments. Unlike other feature-rich frameworks (like NestJS), Vercube maintains a minimalist internal architecture that doesn't burden applications with unnecessary overhead. At the same time, it offers advanced features that typically require additional libraries in lighter frameworks (like Express). |
| 45 | + |
| 46 | +### Superior developer experience |
| 47 | + |
| 48 | +Vercube focuses on excellent developer experience (DX) through: |
| 49 | +- Intuitive decorator-based API |
| 50 | +- Extensive TypeScript hints and support |
| 51 | +- Clear and understandable error messages |
| 52 | +- Consistent and predictable application structure |
| 53 | +- Minimalist configuration while maintaining complete flexibility |
| 54 | + |
| 55 | +### Flexibility and scalability |
| 56 | + |
| 57 | +Vercube offers various levels of abstraction that adapt to project needs: |
| 58 | +- Ability to quickly prototype with "zero-config" configuration |
| 59 | +- Support for modular architecture in larger applications |
| 60 | +- Possibility to integrate with existing libraries and middleware |
| 61 | +- Scalability from simple APIs to complex enterprise applications |
| 62 | +- Full control over the underlying request and response objects |
| 63 | + |
| 64 | +### Compatibility with modern standards |
| 65 | + |
| 66 | +Vercube supports the latest standards and technologies: |
| 67 | +- Full support for ESM (ECMAScript Modules) |
| 68 | +- Backward compatibility with CommonJS |
| 69 | +- Support for the latest TypeScript features |
| 70 | +- Native support for all modern runtime environments (Node.js, Bun, Deno) |
| 71 | + |
| 72 | +### Unique features unavailable in other frameworks |
| 73 | + |
| 74 | +Vercube introduces a number of unique features that distinguish it from the competition: |
| 75 | +- Advanced decorator system that simplifies typical server operations |
| 76 | +- Intelligent detection and auto-configuration system |
| 77 | +- Optimized dependency injection system tailored to TypeScript specifics |
| 78 | +- Flexible middleware system working at different application levels |
| 79 | +- Direct access to native Request/Response objects without abstractions |
| 80 | + |
| 81 | +Vercube is the ideal solution for teams and developers looking for a modern, efficient, and flexible framework that offers excellent developer experience without compromising on performance or functionality. |
0 commit comments