search

schultek / jaspr

Modern web framework for building websites in Dart. Supports SPAs, SSR and SSG.
https://jasprpad.schultek.de
MIT License
1.07k stars 65 forks source link

Jaspr examples are outdated and mostly undocumented #120

Closed dkbast closed 7 months ago

dkbast commented 11 months ago

Description

4 out of 5 of the ./examples are outdated (using older than current versions of jaspr): https://github.com/schultek/jaspr/blob/main/examples/custom_server_middleware/pubspec.yaml https://github.com/schultek/jaspr/blob/main/examples/dart_frog_backend/pubspec.yaml https://github.com/schultek/jaspr/blob/main/examples/riverpod_app/pubspec.yaml https://github.com/schultek/jaspr/blob/main/examples/shelf_backend/pubspec.yaml

It might be worth considering using relative imports for the packages in this repository and creating a github action which makes sure that all examples remain executable.

Expected Behavior

Examples work with the most recent version of jaspr.

Additional Context

It might also be worth thinking about moving the examples into the respective packages, to have an "example" for the pub.dev pages for the packages.

schultek commented 11 months ago

I think there are three todos here:

  1. Improve the documentation of the examples.
  2. Make sure the examples are updated and stay updated and working by integrating something in the ci release workflow.
    • Always update the jaspr dependencies to the latest version in the pubspec.yaml.
    • Then have some automated tests so we know when an example stops working.
  3. Make examples for pub.dev in each package.

The last one has rather low priority for me right now.

schultek commented 11 months ago

I have added some basic documentation to the examples. Also the jaspr version used in examples will now be kept up to date by the ci pipeline.

schultek commented 7 months ago

Hi, I will close this as these are improved by now and I don't have any concrete todos here right now. Feel free to reopen this or another issue if you have any more specific improvement ideas.