Merge pull request #129 from medz/v4

V4

.github/dependabot.yml

@@ -10,3 +10,9 @@ updates:
     directory: /packages/spry
     schedule:
       interval: daily
+
+  # spry_cookie
+  - package-ecosystem: pub
+    directory: /packages/spry_cookie
+    schedule:
+      interval: daily

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Test
+name: test
 
 on:
   push:
@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        packages: [spry]
+        packages: [spry, spry_cookie]
     steps:
       - uses: actions/checkout@v4
       - uses: dart-lang/setup-dart@v1
@@ -23,6 +23,6 @@ jobs:
       - name: Analyze
         run: dart analyze
         working-directory: packages/${{ matrix.packages }}
-      - name: Test
+      - name: run tests
         run: dart test
         working-directory: packages/${{ matrix.packages }}

.gitignore

@@ -1 +1 @@
-node_modules/
+node_modules/

CHANGELOG.md

@@ -0,0 +1,36 @@
+# Spry v4.0.0-0 & Spry cookie v0.0.1
+
+To install Spry v4.0.0-0 & Spry cookie v0.0.1 run this command:
+
+```bash
+dart pub add spry:^4.0.0
+dart pub add spry_cookie:^0.0.1
+```
+
+Or update your `pubspec.yaml` file:
+
+```yaml
+dependencies:
+  spry: ^4.0.0
+  spry_cookie: ^0.0,1
+```
+
+# Spry v4.0.0-dev.2
+
+To install Spry v4.0.0-dev.2 run this command:
+
+```bash
+dart pub add spry:^4.0.0-dev.2
+```
+
+Or update your `pubspec.yaml` file:
+
+```yaml
+dependencies:
+  spry: ^4.0.0-dev.2
+```
+
+## What's Changed
+
+* fixed website url
+* fixed static analysis

README.md

@@ -6,29 +6,23 @@
 [![X (twitter)](https://img.shields.io/badge/twitter-%40shiweidu-blue.svg)](https://twitter.com/shiweidu)
 [![Documentation](https://img.shields.io/badge/docs-spry.fun-brightgreen.svg)](https://spry.fun/)
 
-Spry is an HTTP middleware framework for Dart to make web applications and APIs server more enjoyable to write.
+Spry is a lightweight, composable Dart web framework designed to work collaboratively with various runtime platforms.
 
 ```dart
 import 'package:spry/spry.dart';
 
-main() async {
-  final app = Application.late();
+main() {
+  final app = Spry();
 
-  app.get("hello", (request) => "Hello, Spry!");
-
-  await app.run(port: 3000);
+  app.get("hello", (event) => "Hello, Spry!");
 }
 ```
 
-👉 [**Learn more about Spry at Spry Documentation.**](https://spry.fun/)
-
-## Philosophy
-
-Spry is a framework for building web applications and APIs. It's designed around dart:io, no boring creations, just lots of magic.
+👉 [**Learn more about Spry at documentation website.**](https://spry.fun/guide/getting-started)
 
 ## Sponsors
 
-Spry framework is an [MIT licensed](https://github.com/medz/spry/blob/main/LICENSE) open source project with its ongoing development made possible entirely by the support of these awesome backers. If you'd like to join them, please consider [sponsoring Seven(@medz)](https://github.com/sponsors/odroe) or [sponsor us on OpenCollective](https://opencollective.com/openodroe) development.
+Spry framework is an [MIT licensed](https://github.com/medz/spry/blob/main/LICENSE) open source project with its ongoing development made possible entirely by the support of these awesome backers. If you'd like to join them, please consider [sponsoring Seven(@medz)](https://github.com/sponsors/odroe) development.
 
 <p align="center">
   <a target="_blank" href="https://github.com/sponsors/odroe#sponsors">
@@ -38,12 +32,6 @@ Spry framework is an [MIT licensed](https://github.com/medz/spry/blob/main/LICEN
 
 ## Contributing
 
-We welcome contributions! Please read our [contributing guide](CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Prisma.
-
-Thank you to all the people who already contributed to Odroe!
-
-[![Contributors](https://opencollective.com/openodroe/contributors.svg?width=890)](https://github.com/odroe/prisma-dart/graphs/contributors)
-
-## Code of Conduct
+Thank you to all the people who already contributed to Spry!
 
-This project has adopted the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://www.contributor-covenant.org/faq) or contact [[email protected]](mailto:hello@odroe.com) with any additional questions or comments.
+[![Contributors](https://contrib.rocks/image?repo=medz/spry)](https://github.com/odroe/prisma-dart/graphs/contributors)

docs/.vitepress/config.mts

@@ -1,52 +1,96 @@
-import { defineConfig } from 'vitepress';
+import { defineConfig } from "vitepress";
 
-// https://vitepress.dev/reference/site-config
 export default defineConfig({
-  title: 'Spry',
-  titleTemplate: 'Spry: :title',
+  title: "Spry",
+  titleTemplate: "Spry: :title",
   description:
-    'An HTTP middleware framework for Dart to make web applications and APIs server more enjoyable to write.',
+    "Spry is a lightweight, composable Dart web framework designed to work collaboratively with various runtime platforms.",
+  head: [["link", { rel: "icon", type: "image/svg+xml", href: "/spry.svg" }]],
+  sitemap: {
+    hostname: "https://spry.fun",
+  },
+  cleanUrls: true,
   themeConfig: {
+    logo: {
+      src: "/spry.svg",
+      alt: "Spry",
+    },
     editLink: {
-      pattern: ':repo/edit/:branch/:path',
+      pattern: "https://github.com/medz/spry/edit/main/docs/:path",
     },
+    nav: [
+      {
+        text: "Guide",
+        items: [
+          { text: "App", link: "/guide/app" },
+          { text: "Routing", link: "/guide/routing" },
+          { text: "Handler", link: "/guide/handler" },
+          { text: "Event", link: "/guide/event" },
+          { text: "WebSocket", link: "/guide/websocket/introduction" },
+        ],
+      },
+      {
+        text: "Platforms",
+        items: [
+          { text: "Plain", link: "/platforms/plain" },
+          { text: "IO (dart:io)", link: "/platforms/io" },
+        ],
+      },
+      {
+        text: "Examples",
+        link: "https://github.com/medz/spry/tree/main/examples",
+      },
+    ],
     sidebar: [
+      { text: "What is Spry?", link: "/what-is-spry" },
+      {
+        text: "Getting Started",
+        link: "/getting-started",
+      },
       {
-        text: 'Getting Started',
+        text: "Basics",
         items: [
-          { text: 'Introduction', link: '/getting-started/' },
-          { text: 'Installation', link: '/getting-started/installation' },
-          { text: 'Hello World', link: '/getting-started/hello-world' },
+          { text: "App", link: "/guide/app" },
+          { text: "Routing", link: "/guide/routing" },
+          { text: "Handler", link: "/guide/handler" },
+          { text: "Event", link: "/guide/event" },
         ],
       },
       {
-        text: 'Basics',
+        text: "WebSocket",
         items: [
-          { text: 'Routing', link: '/basics/routing' },
-          { text: 'Controllers', link: '/basics/controllers' },
-          { text: 'Request', link: '/basics/request' },
-          { text: 'Response', link: '/basics/response' },
-          { text: 'Errors & Exceptions', link: '/basics/exceptions' },
+          { text: "Introduction", link: "/guide/websocket/introduction" },
+          { text: "Hooks", link: "/guide/websocket/hooks" },
+          { text: "Peer", link: "/guide/websocket/peer" },
+          { text: "Message", link: "/guide/websocket/message" },
         ],
       },
       {
-        text: 'Advanced',
+        text: "Advanced",
+        items: [{ text: "Cookies", link: "/advanced/cookies" }],
+      },
+      {
+        text: "Platforms",
         items: [
-          { text: 'Handler', link: '/advanced/handler' },
-          { text: 'Middleware', link: '/advanced/middleware' },
-          { text: 'Sessions', link: '/advanced/sessions' },
-          { text: 'Application', link: '/advanced/application' },
-          { text: 'WebSockets', link: '/advanced/websockets' },
+          {
+            text: "Create a new platform",
+            link: "/platforms/create",
+          },
+          { text: "Plain", link: "/platforms/plain" },
+          { text: "IO (dart:io)", link: "/platforms/io" },
         ],
       },
     ],
-
     socialLinks: [
-      { icon: 'github', link: 'https://github.com/medz/spry' },
+      { icon: "github", link: "https://github.com/medz/spry" },
       {
-        icon: 'twitter',
-        link: 'https://twitter.com/shiweidu',
+        icon: "twitter",
+        link: "https://twitter.com/shiweidu",
       },
     ],
+    footer: {
+      message: "Released under the MIT License.",
+      copyright: `Copyright © ${new Date().getFullYear()} Seven Du`,
+    },
   },
 });