File size: 3,653 Bytes
4d35814 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 | // README Content
export const README_MD = String.raw`
# π Awesome Web Framework
[](https://www.npmjs.com/package/awesome-framework)
[](https://github.com/awesome/framework/actions)
[](https://codecov.io/gh/awesome/framework)
[](https://opensource.org/licenses/MIT)
> A modern, fast, and flexible web framework for building scalable applications
## β¨ Features
- π― **Type-Safe** - Full TypeScript support out of the box
- β‘ **Lightning Fast** - Built on Vite for instant HMR
- π¦ **Zero Config** - Works out of the box for most use cases
- π¨ **Flexible** - Unopinionated with sensible defaults
- π§ **Extensible** - Plugin system for custom functionality
- π± **Responsive** - Mobile-first approach
- π **i18n Ready** - Built-in internationalization
- π **Secure** - Security best practices by default
## π¦ Installation
${'```'}bash
npm install awesome-framework
# or
yarn add awesome-framework
# or
pnpm add awesome-framework
${'```'}
## π Quick Start
### Create a new project
${'```'}bash
npx create-awesome-app my-app
cd my-app
npm run dev
${'```'}
### Basic Example
${'```'}javascript
import { createApp } from 'awesome-framework';
const app = createApp({
port: 3000,
middleware: ['cors', 'helmet', 'compression']
});
app.get('/', (req, res) => {
res.json({ message: 'Hello World!' });
});
app.listen(() => {
console.log('Server running on http://localhost:3000');
});
${'```'}
## π Documentation
### Core Concepts
- [Getting Started](https://docs.awesome.dev/getting-started)
- [Configuration](https://docs.awesome.dev/configuration)
- [Routing](https://docs.awesome.dev/routing)
- [Middleware](https://docs.awesome.dev/middleware)
- [Database](https://docs.awesome.dev/database)
- [Authentication](https://docs.awesome.dev/authentication)
### Advanced Topics
- [Performance Optimization](https://docs.awesome.dev/performance)
- [Deployment](https://docs.awesome.dev/deployment)
- [Testing](https://docs.awesome.dev/testing)
- [Security](https://docs.awesome.dev/security)
## π οΈ Development
### Prerequisites
- Node.js >= 18
- pnpm >= 8
### Setup
${'```'}bash
git clone https://github.com/awesome/framework.git
cd framework
pnpm install
pnpm dev
${'```'}
### Testing
${'```'}bash
pnpm test # Run unit tests
pnpm test:e2e # Run end-to-end tests
pnpm test:watch # Run tests in watch mode
${'```'}
## π€ Contributing
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
### Contributors
<a href="https://github.com/awesome/framework/graphs/contributors">
<img src="https://contrib.rocks/image?repo=awesome/framework" />
</a>
## π Benchmarks
| Framework | Requests/sec | Latency (ms) | Memory (MB) |
|-----------|-------------|--------------|-------------|
| **Awesome** | **45,230** | **2.1** | **42** |
| Express | 28,450 | 3.5 | 68 |
| Fastify | 41,200 | 2.3 | 48 |
| Koa | 32,100 | 3.1 | 52 |
*Benchmarks performed on MacBook Pro M2, Node.js 20.x*
## π License
MIT Β© [Awesome Team](https://github.com/awesome)
## π Acknowledgments
Special thanks to all our sponsors and contributors who make this project possible.
---
**[Website](https://awesome.dev)** β’ **[Documentation](https://docs.awesome.dev)** β’ **[Discord](https://discord.gg/awesome)** β’ **[Twitter](https://twitter.com/awesomeframework)**
`;
|