Merge branch 'develop'

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,24 @@
+---
+name: Bug
+about: Create a report to warn us about a bug
+title: "fix: "
+labels: bug
+---
+
+**What happened**
+
+A simple and clear description of what the bug is.
+
+**Code**
+
+```dart
+void main() {
+
+    /// your code goes here
+
+}
+```
+
+**What should have happened**
+
+A simple and clear description of what you expected to happen.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature.md

@@ -0,0 +1,15 @@
+---
+name: Feature
+about: A new feature to be added to the project
+title: "feat: "
+labels: feature
+---
+
+**Description**
+
+Clearly describe what you are looking to add. The more context the better.
+
+**Requirements**
+
+- [ ] Checklist of requirements to be fulfilled
+- [ ] Another requirement

.github/pull_request_template.md

@@ -0,0 +1,26 @@
+# Description
+
+Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+# Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
+

.github/workflows/serinus_docs_deploy.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - 'docs/**'
   pull_request:
     types: [opened, synchronize, reopened, closed]
     branches:

.github/workflows/serinus_tests.yml

@@ -29,14 +29,15 @@ jobs:
         run: |
           dart pub global activate coverage
           export SERINUS_TEST=true
-          dart test --coverage=coverage test/serinus.dart && dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info --packages=.dart_tool/package_config.json --report-on=${{inputs.report_on}}
+          dart test --coverage=coverage && dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info --packages=.dart_tool/package_config.json --report-on=${{inputs.report_on}}
       
       - name: 📊 Check Code Coverage
         uses: VeryGoodOpenSource/very_good_coverage@v2
         with:
           path: ./packages/serinus/coverage/lcov.info
-          min_coverage: 70
+          min_coverage: 80
 
       - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v3
-
+        uses: codecov/codecov-action@v4
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.website/.vitepress/config.mts

@@ -11,18 +11,20 @@ export default defineConfig({
   ],
   lastUpdated: true,
   themeConfig: {
+    footer: {
+      copyright: 'Copyright © 2024 Francesco Vallone',
+      message: 'Built with 💙 and Dart 🎯 | One of the 🐤 of <a href="https://github.com/serinus-nest">Serinus Nest</a>'
+    },
     // https://vitepress.dev/reference/default-theme-config
     logo: '/serinus-logo.png',
     nav: [
       {
         text: 'pub.dev',
         link: 'https://pub.dev/packages/serinus'
-      }
+      },
     ],
     sidebar: [
       {
-        text: 'Serinus - Dart Backend Framework',
-        link: '/',
         items: [
           { text: 'Introduction', link: '/introduction' },
           {
@@ -44,6 +46,15 @@ export default defineConfig({
               { text: 'Model View Controller', link: '/techniques/mvc' },
               { text: 'Versioning', link: '/techniques/versioning' },
             ]
+          },
+          {
+            text: 'Plugins',
+            items: [
+              { text: 'Configuration', link: '/plugins/configuration' },
+              { text: 'Serve Static Files [WIP]' },
+              { text: 'Swagger [WIP]' }
+            ],
+            link: '/plugins/'
           }
         ]
       },
@@ -54,7 +65,8 @@ export default defineConfig({
     ],
     socialLinks: [
       { icon: 'github', link: 'https://github.com/francescovallone/serinus' },
-      { icon: 'twitter', link: 'https://twitter.com/serinus_nest'}
+      { icon: 'twitter', link: 'https://twitter.com/serinus_nest'},
+      { icon: 'discord', link: 'https://discord.gg/zydgnJ3ksJ' }
     ]
   }
 })

.website/.vitepress/theme/style.css

@@ -92,7 +92,7 @@
 }
 
 .image-bg {
-	background-image: linear-gradient(-45deg, hsla(36, 100%, 75%, 0.5) 50%, hsla(36, 100%, 50%, 0.5) 50%) !important;
-	background-image: -moz-linear-gradient(-45deg, hsla(36, 100%, 75%, 0.5) 50%, hsla(36, 100%, 50%, 0.5) 50%) !important;
-	background-image: -webkit-linear-gradient(-45deg, hsla(36, 100%, 75%, 0.5) 50%, hsla(36, 100%, 50%, 0.5) 50%) !important;
+	background-image: linear-gradient(-45deg, rgba(255, 152, 0, 0.6) 50%, rgba(245, 124, 0, 0.6) 50%) !important;
+	background-image: -moz-linear-gradient(-45deg, rgba(255, 152, 0, 0.6) 50%, rgba(245, 124, 0, 0.6) 50%) !important;
+	background-image: -webkit-linear-gradient(-45deg, rgba(255, 152, 0, 0.6) 50%, rgba(245, 124, 0, 0.6) 50%) !important;
 }

.website/overview/pipes.md

@@ -26,7 +26,7 @@ import 'package:serinus/serinus.dart';
 
 class MyController extends Controller {
   MyController({super.path = '/'}) {
-    on(GetRoute(path: '/'), (context, request) {
+    on(GetRoute(path: '/'), (context) {
       return Response.text(
         data: 'Hello World!',
       );

.website/overview/providers.md

@@ -56,15 +56,14 @@ If you want to use a provider from a submodule, you must add the `Type` of the p
 import 'package:serinus/serinus.dart';
 
 class MyController extends Controller {
-  MyController({super.path = '/'});
-
-  @override
-  Future<Response> handle(Request request) async {
-    final myProvider = context.get<MyProvider>();
-    return Response.text(
-      data: 'Hello World!',
-    );
+  MyController({super.path = '/'}){
+    on(GetRoute(path: '/'), (context) {
+      return Response.text(
+        data: context.use<MyProvider>().myMethod(),
+      );
+    });
   }
+
 }
 ```
 

.website/overview/routes.md

@@ -8,6 +8,7 @@ They only exposes the endpoint and the method that the route will respond to so
 To add routes you first need to create a class that extends the `Route` class and then add it to the controller using the `on` method.
 
 ::: code-group
+
 ```dart [my_controller.dart]
 import 'package:serinus/serinus.dart';
 import 'my_routes.dart';
@@ -22,6 +23,7 @@ class MyController extends Controller {
   }
 }
 ```
+
 ```dart [my_routes.dart]
 import 'package:serinus/serinus.dart';
 
@@ -34,6 +36,7 @@ class GetRoute extends Route {
 
 }
 ```
+
 :::
 
 ## Query Parameters
@@ -61,6 +64,7 @@ class GetRoute extends Route {
 To define a path parameter you need to add the parameter name between `<` and `>` in the path of the route.
 
 ::: code-group
+
 ```dart [my_controller.dart]
 
 import 'package:serinus/serinus.dart';
@@ -76,6 +80,7 @@ class MyController extends Controller {
   }
 }
 ```
+
 ```dart [my_routes.dart]
 import 'package:serinus/serinus.dart';
 
@@ -88,6 +93,7 @@ class GetRoute extends Route {
 
 }
 ```
+
 :::
 
 ## Adding Pipes

.website/plugins/configuration.md

@@ -0,0 +1,45 @@
+# Config <Badge type="tip" text="^0.2.1"/>
+
+Serinus Config is a plugin that allows to load .env files in your Serinus application.
+
+::: warning
+This plugin uses the [dotenv](https://pub.dev/packages/dotenv) package to load the .env files.
+:::
+
+## Installation
+
+The installation of the plugin is immediate and can be done using the following command:
+
+```bash
+dart pub add serinus_config
+```
+
+## Usage
+
+To use the plugin, you need to import it in your entrypoint module:
+
+```dart
+import 'package:serinus_config/serinus_config.dart';
+import 'package:serinus/serinus.dart';
+
+class AppModule extends Module {
+
+  AppModule() : super(imports: [ConfigModule()]);
+
+}
+```
+
+### Options
+
+The plugin allows you to specify the path of the .env file to load using the `dotEnvPath` parameter. The default value is `.env`.
+
+```dart
+import 'package:serinus_config/serinus_config.dart';
+import 'package:serinus/serinus.dart';
+
+class AppModule extends Module {
+
+  AppModule() : super(imports: [ConfigModule(dotEnvPath: '.env')]);
+
+}
+```

.website/plugins/index.md

@@ -0,0 +1,7 @@
+# Plugins
+
+This is a list of plugins that are available for Serinus. If you would like to add your own plugin, please submit a pull request to the [Serinus GitHub repository](https://github.com/francescovallone/serinus).
+
+## Official Plugins
+
+- [Configuration](/plugins/configuration)

.website/techniques/mvc.md

@@ -76,7 +76,7 @@ import 'package:serinus/serinus.dart';
 
 class MyController extends Controller {
   MyController({super.path = '/'}) {
-    on(GetRoute(path: '/'), (context, request) {
+    on(GetRoute(path: '/'), (context) {
       // This refers to the view file `views/index.mustache`
       return Response.render(View(view: 'index', variables: {'name': 'Serinus'}));
     });
@@ -89,7 +89,7 @@ import 'package:serinus/serinus.dart';
 
 class MyController extends Controller {
   MyController({super.path = '/'}) {
-    on(GetRoute(path: '/'), (context, request) {
+    on(GetRoute(path: '/'), (context) {
       return Response.renderString(ViewString(viewData: 'Hello {{name}}', variables: {'name': 'Serinus'}));
     });
   }

.website/techniques/versioning.md

@@ -77,7 +77,7 @@ class MyController extends Controller {
     int get version => 2;
 
     MyController({super.path = '/'}) {
-        on(GetRoute(path: '/'), (context, request) {
+        on(GetRoute(path: '/'), (context) {
             return Response.text('Hello, World!');
         });
     }