readme.ts 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. // README Content
  2. export const README_MD = String.raw`
  3. # 🚀 Awesome Web Framework
  4. [![npm version](https://img.shields.io/npm/v/awesome-framework.svg)](https://www.npmjs.com/package/awesome-framework)
  5. [![Build Status](https://github.com/awesome/framework/workflows/CI/badge.svg)](https://github.com/awesome/framework/actions)
  6. [![Coverage](https://codecov.io/gh/awesome/framework/branch/main/graph/badge.svg)](https://codecov.io/gh/awesome/framework)
  7. [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
  8. > A modern, fast, and flexible web framework for building scalable applications
  9. ## ✨ Features
  10. - 🎯 **Type-Safe** - Full TypeScript support out of the box
  11. - ⚡ **Lightning Fast** - Built on Vite for instant HMR
  12. - 📦 **Zero Config** - Works out of the box for most use cases
  13. - 🎨 **Flexible** - Unopinionated with sensible defaults
  14. - 🔧 **Extensible** - Plugin system for custom functionality
  15. - 📱 **Responsive** - Mobile-first approach
  16. - 🌍 **i18n Ready** - Built-in internationalization
  17. - 🔒 **Secure** - Security best practices by default
  18. ## 📦 Installation
  19. ${'```'}bash
  20. npm install awesome-framework
  21. # or
  22. yarn add awesome-framework
  23. # or
  24. pnpm add awesome-framework
  25. ${'```'}
  26. ## 🚀 Quick Start
  27. ### Create a new project
  28. ${'```'}bash
  29. npx create-awesome-app my-app
  30. cd my-app
  31. npm run dev
  32. ${'```'}
  33. ### Basic Example
  34. ${'```'}javascript
  35. import { createApp } from 'awesome-framework';
  36. const app = createApp({
  37. port: 3000,
  38. middleware: ['cors', 'helmet', 'compression']
  39. });
  40. app.get('/', (req, res) => {
  41. res.json({ message: 'Hello World!' });
  42. });
  43. app.listen(() => {
  44. console.log('Server running on http://localhost:3000');
  45. });
  46. ${'```'}
  47. ## 📖 Documentation
  48. ### Core Concepts
  49. - [Getting Started](https://docs.awesome.dev/getting-started)
  50. - [Configuration](https://docs.awesome.dev/configuration)
  51. - [Routing](https://docs.awesome.dev/routing)
  52. - [Middleware](https://docs.awesome.dev/middleware)
  53. - [Database](https://docs.awesome.dev/database)
  54. - [Authentication](https://docs.awesome.dev/authentication)
  55. ### Advanced Topics
  56. - [Performance Optimization](https://docs.awesome.dev/performance)
  57. - [Deployment](https://docs.awesome.dev/deployment)
  58. - [Testing](https://docs.awesome.dev/testing)
  59. - [Security](https://docs.awesome.dev/security)
  60. ## 🛠️ Development
  61. ### Prerequisites
  62. - Node.js >= 18
  63. - pnpm >= 8
  64. ### Setup
  65. ${'```'}bash
  66. git clone https://github.com/awesome/framework.git
  67. cd framework
  68. pnpm install
  69. pnpm dev
  70. ${'```'}
  71. ### Testing
  72. ${'```'}bash
  73. pnpm test # Run unit tests
  74. pnpm test:e2e # Run end-to-end tests
  75. pnpm test:watch # Run tests in watch mode
  76. ${'```'}
  77. ## 🤝 Contributing
  78. We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
  79. ### Contributors
  80. <a href="https://github.com/awesome/framework/graphs/contributors">
  81. <img src="https://contrib.rocks/image?repo=awesome/framework" />
  82. </a>
  83. ## 📊 Benchmarks
  84. | Framework | Requests/sec | Latency (ms) | Memory (MB) |
  85. |-----------|-------------|--------------|-------------|
  86. | **Awesome** | **45,230** | **2.1** | **42** |
  87. | Express | 28,450 | 3.5 | 68 |
  88. | Fastify | 41,200 | 2.3 | 48 |
  89. | Koa | 32,100 | 3.1 | 52 |
  90. *Benchmarks performed on MacBook Pro M2, Node.js 20.x*
  91. ## 📝 License
  92. MIT © [Awesome Team](https://github.com/awesome)
  93. ## 🙏 Acknowledgments
  94. Special thanks to all our sponsors and contributors who make this project possible.
  95. ---
  96. **[Website](https://awesome.dev)** • **[Documentation](https://docs.awesome.dev)** • **[Discord](https://discord.gg/awesome)** • **[Twitter](https://twitter.com/awesomeframework)**
  97. `;