@teamvelix/velix 5.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Velix Team
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,117 @@
1
+ # Velix v5
2
+
3
+ <p align="center">
4
+ <img src="./assets/velix cover.webp" width="100%" alt="Velix Cover" />
5
+ </p>
6
+
7
+ > **A modern full-stack React framework** optimized for performance, SEO, simplicity, and developer experience.
8
+
9
+ Velix is a lightweight but powerful React 19 framework featuring file-based routing, SSR, SSG, Islands architecture, built-in SEO optimization, and an intuitive CLI.
10
+
11
+ ## ✨ Features
12
+
13
+ - ⚡ **React 19** — Latest React with Server Components & Actions
14
+ - 📁 **File-based Routing** — Intuitive `app/` directory convention
15
+ - 🏝️ **Islands Architecture** — Partial hydration for minimal JavaScript
16
+ - 🔍 **SEO First** — Automatic meta tags, Open Graph, sitemaps, robots.txt
17
+ - 🖥️ **SSR + SSG + ISR** — Choose the right rendering for each page
18
+ - 🧩 **Plugin System** — Extend with auth, database, analytics, and more
19
+ - 🛠️ **Powerful CLI** — Scaffold pages, components, APIs, and more
20
+ - 🔧 **DevTools** — Route explorer, hydration inspector, performance metrics
21
+ - 📦 **Edge Ready** — Deploy to any edge platform
22
+ - 🤖 **AI Assistant** — Built-in CLI AI for code generation
23
+
24
+ ## 📦 Quick Start
25
+
26
+ ```bash
27
+ npx create-velix-app my-app
28
+ cd my-app
29
+ npm run dev
30
+ ```
31
+
32
+ ## 📁 Project Structure
33
+
34
+ ```
35
+ my-velix-app/
36
+ ├── app/
37
+ │ ├── layout.tsx → Root layout
38
+ │ ├── page.tsx → Home page (/)
39
+ │ ├── dashboard/
40
+ │ │ ├── layout.tsx → Dashboard layout
41
+ │ │ ├── page.tsx → /dashboard
42
+ │ │ └── [id].tsx → /dashboard/:id
43
+ │ └── blog/
44
+ │ ├── page.tsx → /blog
45
+ │ └── [slug].tsx → /blog/:slug
46
+ ├── components/
47
+ ├── server/
48
+ │ ├── loaders/
49
+ │ └── actions/
50
+ ├── styles/
51
+ ├── velix.config.ts
52
+ └── package.json
53
+ ```
54
+
55
+ ## ⚙️ Configuration
56
+
57
+ ```ts
58
+ // velix.config.ts
59
+ import { defineConfig } from "velix";
60
+
61
+ export default defineConfig({
62
+ app: {
63
+ name: "My App",
64
+ url: "https://example.com"
65
+ },
66
+ server: { port: 3000 },
67
+ seo: {
68
+ sitemap: true,
69
+ robots: true,
70
+ openGraph: true
71
+ },
72
+ plugins: ["velix-auth", "velix-db"]
73
+ });
74
+ ```
75
+
76
+ ## 🛠️ CLI Commands
77
+
78
+ ```bash
79
+ velix dev # Start dev server
80
+ velix build # Build for production
81
+ velix start # Start production server
82
+ velix doctor # Health check
83
+
84
+ velix g page <name> # Generate a page
85
+ velix g component <name> # Generate a component
86
+ velix g api <name> # Generate an API route
87
+ velix g layout <name> # Generate a layout
88
+ velix g middleware <name> # Generate middleware
89
+
90
+ velix ai start # Launch AI assistant
91
+ velix analyze # Bundle analysis
92
+ velix info # Framework info
93
+ ```
94
+
95
+ ## � Documentation
96
+
97
+ Comprehensive guides and API references:
98
+
99
+ - **[Getting Started](./docs/README.md)** - Quick start guide and overview
100
+ - **[Server Actions](./docs/server-actions.md)** - Execute server code from components
101
+ - **[API Routes](./docs/api-routes.md)** - Create custom HTTP endpoints
102
+ - **[Best Practices](./docs/best-practices.md)** - Development guidelines
103
+ - **[Roadmap](./docs/roadmap.md)** - Upcoming features and plugins
104
+
105
+ ## 🤝 Contributing
106
+
107
+ We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for details.
108
+
109
+ ## 💬 Community
110
+
111
+ - **Discord**: [Join our community](https://discord.gg/velix)
112
+ - **GitHub Discussions**: [Ask questions & share ideas](https://github.com/velix/velix/discussions)
113
+ - **Twitter**: [@VelixFramework](https://twitter.com/VelixFramework)
114
+
115
+ ## �📄 License
116
+
117
+ MIT © Velix Team
Binary file
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Velix v5 Build System
3
+ * Production build using esbuild
4
+ */
5
+ interface BuildOptions {
6
+ projectRoot?: string;
7
+ outDir?: string;
8
+ minify?: boolean;
9
+ sourcemap?: boolean;
10
+ }
11
+ /**
12
+ * Build the Velix application for production
13
+ */
14
+ declare function build(options?: BuildOptions): Promise<void>;
15
+ declare const _default: {
16
+ build: typeof build;
17
+ };
18
+
19
+ export { type BuildOptions, build, _default as default };